Sms

List SMS/MMS services.

get

Retrieve a collection of SMS/MMS services.

Authorizations

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

4XX

Error

get

HTTPcURLJavaScriptPython

GET /api/sms HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Create SMS/MMS service

post

Create SMS/MMS service.

Authorizations

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_idall ofRequired

The unique ID of trunk.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

sender_idstringOptional

The sender ID of SMS/MMS service.

credentialsstringRequired

The credentials of SMS/MMS service.

Responses

201

Created

application/json

4XX

Error

post

HTTPcURLJavaScriptPython

POST /api/sms HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 111

{
  "name": "text",
  "enabled": true,
  "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "sender_id": "text",
  "credentials": "text"
}

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Retrieve a SMS/MMS service

get

Retrieve a SMS/MMS service.

Authorizations

Path parameters

idall ofRequired

The unique ID of SMS/MMS service.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

HTTPcURLJavaScriptPython

GET /api/sms/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Update the SMS/MMS service

post

Update the SMS/MMS service.

Authorizations

Path parameters

idall ofRequired

The unique ID of SMS/MMS service.

stringOptional

The unique ID of the resource.

Example: 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.

credentialsstringOptional

The credentials of SMS/MMS service.

Responses

200

OK

4XX

Error

post

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "enabled": true,
  "sender_id": "text",
  "credentials": "text"
}

No content