Sms
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.
0
Use the top
query parameter to specify the page size of the result set.
100
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.
The name of SMS/MMS service.
The flag for whether the SMS/MMS service is enabled.
true
The unique ID of trunk.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
The sender ID of SMS/MMS service.
The credentials of SMS/MMS service.
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.
The unique ID of SMS/MMS service.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
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.
The unique ID of SMS/MMS service.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYw
The name of SMS/MMS service.
The flag for whether the SMS/MMS service is enabled.
true
The sender ID of SMS/MMS service.
The credentials of SMS/MMS service.
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