Sms

List SMS/MMS services.

Retrieve a collection of SMS/MMS services.

GEThttp://127.0.0.1:8888/api/sms

Query parameters

Response

2004XX

OK

Body

application/json

countinteger (int64)

Total number of resource.

Example: 100

itemsarray of object

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/sms', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Create SMS/MMS service

Create SMS/MMS service.

POSThttp://127.0.0.1:8888/api/sms

Body

application/json

name*string

The name of SMS/MMS service.

enabledboolean

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

provider_id*all of

The unique ID of trunk.

sender_idstring

The sender ID of SMS/MMS service.

credentials*string

The credentials of SMS/MMS service.

Response

2014XX

Created

Body

application/json

idall of

The unique ID of SMS/MMS service.

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/sms', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "provider_id": {},
      "credentials": "text"
    }),
});
const data = await response.json();

Response

201

{
  "id": {}
}

Retrieve a SMS/MMS service

Retrieve a SMS/MMS service.

GEThttp://127.0.0.1:8888/api/sms/{id}

Path parameters

id*all of

The unique ID of SMS/MMS service.

Response

2004XX

OK

Body

application/json

idall of

The unique ID of SMS/MMS service.

namestring

The name of SMS/MMS service.

enabledboolean

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.

provider_idall of

The unique ID of trunk.

provider_namestring

The name of the trunk.

provider_hostnameall of

The hostname of trunk.

webhookstring

The Universal Resource Locator of some resource.

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/sms/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Update the SMS/MMS service

Update the SMS/MMS service.

POSThttp://127.0.0.1:8888/api/sms/{id}

Path parameters

id*all of

The unique ID of SMS/MMS service.

Body

application/json

namestring

The name of SMS/MMS service.

enabledboolean

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.

Response

2004XX

OK

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/sms/{id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();