SMS/MMS
Retrieve a collection of SMS/MMS services.
Use the filter query parameter to retrieve just a subset of a collection.
Use the search query parameter to restrict the results of a request to match a search criterion.
Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.
Use the skip query parameter to set the number of items to skip at the start of a collection.
0Use the top query parameter to specify the page size of the result set.
100OK
Total number of resource.
100Error
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.
The name of SMS/MMS service.
The flag for whether the SMS/MMS service is enabled.
trueNzAwNTUxOTA5NzczMTQ4MTYwThe sender ID of SMS/MMS service.
Prepend “+” to outbound SMS recipient numbers.
The credentials of SMS/MMS service.
The channel type of SMS Trunk.
Can be either:
SMSOnly text messages are allowed.MMS: Multimedia messages are allowed.
SMSPossible values: Created
NzAwNTUxOTA5NzczMTQ4MTYwError
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.
NzAwNTUxOTA5NzczMTQ4MTYwOK
NzAwNTUxOTA5NzczMTQ4MTYwThe name of SMS/MMS service.
The flag for whether the SMS/MMS service is enabled.
trueThe sender ID of SMS/MMS service.
NzAwNTUxOTA5NzczMTQ4MTYwPrepend “+” to outbound SMS recipient numbers.
The name of the trunk.
The brand of trunk.
Server hostname or IP address
The Universal Resource Locator of some resource.
The channel type of SMS Trunk.
Can be either:
SMSOnly text messages are allowed.MMS: Multimedia messages are allowed.
SMSPossible values: Error
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.
NzAwNTUxOTA5NzczMTQ4MTYwThe name of SMS/MMS service.
The flag for whether the SMS/MMS service is enabled.
trueThe sender ID of SMS/MMS service.
Prepend “+” to outbound SMS recipient numbers.
The credentials of SMS/MMS service.
The channel type of SMS Trunk.
Can be either:
SMSOnly text messages are allowed.MMS: Multimedia messages are allowed.
SMSPossible values: OK
No content
Error
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
Destroy a SMS/MMS service
NzAwNTUxOTA5NzczMTQ4MTYwNo Content
No content
Error
POST /api/sms/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Last updated
Was this helpful?