For the complete documentation index, see llms.txt. This page is also available as Markdown.

SMS/MMS

List SMS/MMS services.

get

Retrieve a collection of SMS/MMS services.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
filterstringOptional

Use the filter query parameter to retrieve just a subset of a collection.

searchstringOptional

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystringOptional

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32Optional

Use the skip query parameter to set the number of items to skip at the start of a collection.

Default: 0
topinteger · int32 · min: 1 · max: 100Optional

Use the top query parameter to specify the page size of the result set.

Default: 100
Responses
200

OK

application/json
countinteger · int64Optional

Total number of resource.

Example: 100
get/sms
GET /api/sms HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "count": 1,
  "items": [
    {
      "id": "xxxxxx",
      "name": "example",
      "enabled": true,
      "sender_id": "",
      "provider_id": "xxxxxx",
      "provider_name": "example",
      "provider_brand": "Generic",
      "provider_hostname": "example",
      "webhook": "https://example.com",
      "channel_type": "SMS"
    }
  ]
}

Create SMS/MMS service

post

Create SMS/MMS service.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
namestring · min: 1 · max: 64Required

The name of SMS/MMS service.

enabledbooleanOptional

The flag for whether the SMS/MMS service is enabled.

Default: true
provider_idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw
sender_idstringOptional

The sender ID of SMS/MMS service.

prepend_addstringOptional

Prepend “+” to outbound SMS recipient numbers.

credentialsstringRequired

The credentials of SMS/MMS service.

channel_typestring · enumOptional

The channel type of SMS Trunk.
Can be either:

  • SMS Only text messages are allowed.
  • MMS: Multimedia messages are allowed.
Default: SMSPossible values:
Responses
201

Created

application/json
idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw
post/sms
POST /api/sms HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 109

{
  "name": "example",
  "enabled": true,
  "provider_id": "xxxxxx",
  "sender_id": "",
  "credentials": "",
  "channel_type": "SMS"
}
{
  "id": "xxxxxxxx"
}

Retrieve a SMS/MMS service

get

Retrieve a SMS/MMS service.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200

OK

application/json
idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw
namestring · min: 1 · max: 64Optional

The name of SMS/MMS service.

enabledbooleanOptional

The flag for whether the SMS/MMS service is enabled.

Default: true
sender_idstringOptional

The sender ID of SMS/MMS service.

provider_idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw
prepend_addstringOptional

Prepend “+” to outbound SMS recipient numbers.

provider_namestring · min: 1 · max: 64Optional

The name of the trunk.

provider_brandstring · min: 1 · max: 64Optional

The brand of trunk.

provider_hostnamestringOptional

Server hostname or IP address

webhookstring · min: 1Optional

The Universal Resource Locator of some resource.

channel_typestring · enumOptional

The channel type of SMS Trunk.
Can be either:

  • SMS Only text messages are allowed.
  • MMS: Multimedia messages are allowed.
Default: SMSPossible values:
get/sms/{id}
GET /api/sms/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "id": "xxxxxx",
  "name": "example",
  "enabled": true,
  "sender_id": "",
  "provider_id": "xxxxxx",
  "provider_name": "example",
  "provider_brand": "Generic",
  "provider_hostname": "example",
  "webhook": "https://example.com",
  "channel_type": "SMS"
}

Update the SMS/MMS service

post

Update the SMS/MMS service.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw
Body
namestring · min: 1 · max: 64Optional

The name of SMS/MMS service.

enabledbooleanOptional

The flag for whether the SMS/MMS service is enabled.

Default: true
sender_idstringOptional

The sender ID of SMS/MMS service.

prepend_addstringOptional

Prepend “+” to outbound SMS recipient numbers.

credentialsstringOptional

The credentials of SMS/MMS service.

channel_typestring · enumOptional

The channel type of SMS Trunk.
Can be either:

  • SMS Only text messages are allowed.
  • MMS: Multimedia messages are allowed.
Default: SMSPossible values:
Responses
200

OK

No content

post/sms/{id}
POST /api/sms/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 86

{
  "name": "example",
  "enabled": true,
  "sender_id": "",
  "credentials": "",
  "channel_type": "SMS"
}

No content

Delete SMS/MMS service

post

Destroy a SMS/MMS service

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
204

No Content

No content

post/sms/{id}/destroy
POST /api/sms/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Last updated

Was this helpful?