Sms

PreviousDestroy NextDestroy

Was this helpful?

List SMS/MMS services.

Retrieve a collection of SMS/MMS services.

get

/sms

Authorizations

Query parameters

filterstring

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

searchstring

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

orderbystring

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

skipinteger · int32

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

topinteger · int32 · min: 1 · max: 100 · default: 100

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/sms' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

{
  "count": 100,
  "items": [
    {
      "name": "text",
      "enabled": true,
      "sender_id": "text",
      "provider_name": "text",
      "provider_brand": "text",
      "webhook": "text",
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "provider_hostname": "text"
    }
  ]
}

Create SMS/MMS service

Create SMS/MMS service.

post

/sms

Authorizations

Body

namestring · min: 1 · max: 64required

The name of SMS/MMS service.

enabledboolean · default: true

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

sender_idstring

The sender ID of SMS/MMS service.

credentialsstringrequired

The credentials of SMS/MMS service.

provider_idall ofrequired

The unique ID of trunk.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/sms' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","enabled":true,"credentials":"text","provider_id":"NzAwNTUxOTA5NzczMTQ4MTYw"}'

201

4XX

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Created

Retrieve a SMS/MMS service

Retrieve a SMS/MMS service.

get

/sms/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of SMS/MMS service.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/sms/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

{
  "name": "text",
  "enabled": true,
  "sender_id": "text",
  "provider_name": "text",
  "provider_brand": "text",
  "webhook": "text",
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "provider_hostname": "text"
}

Update the SMS/MMS service

Update the SMS/MMS service.

post

/sms/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of SMS/MMS service.

Body

namestring · min: 1 · max: 64

The name of SMS/MMS service.

enabledboolean · default: true

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

sender_idstring

The sender ID of SMS/MMS service.

credentialsstring

The credentials of SMS/MMS service.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/sms/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"enabled":true}'

200

4XX

No body