Carrier API
This documentation is intended for carriers as defined in the carrier documentation. The API documentation for Somleng's Open Source implementation of Twilio's REST API is available here.
The Carrier API is intended for carriers who need to automate provisioning of carrier resources (e.g. Accounts) rather that using the dashboard. This API is written according to the JSON API Specification. We recommend using a JSON API Client for consuming this API.
Authentication
This API uses Bearer authentication. You must include your API key in the Authorization header for all requests. Your API key is available on the Carrier Dashboard.
Webhooks
Somleng uses webhooks to notify your application when an event happens in your account.
Somleng signs the webhook events it sends to your endpoint by including a signature in each event's Authorization header.
This allows you to verify that the events were sent by Somleng, not by a third party.
All requests are signed using JSON Web Token (JWT) Bearer authentication, according to the HS256 (HMAC-SHA256) algorithm.
You should verify the events that Somleng sends to your Webhook endpoints. On the right is an example in Ruby ---->
JWT.decode(
request.headers["Authorization"].sub("Bearer ", ""),
"[your-webhook-signing-secret]",
true,
algorithm: "HS256",
verify_iss: true,
iss: "Somleng"
)
Accounts
Create an account
Request
curl "https://api.somleng.org/carrier/v1/accounts" -d '{
"data": {
"type": "account",
"attributes": {
"name": "Rocket Rides",
"default_tts_voice": "Basic.Kal",
"billing_enabled": true,
"billing_mode": "prepaid",
"metadata": {
"foo": "bar"
}
}
}
}' -X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer 6gEQLwgTLYw3O5Tv9X0nlLz2GZTx_JgGAycgHV84adQ"
Endpoint
POST https://api.somleng.org/carrier/v1/accounts
POST https://api.somleng.org/carrier/v1/accounts
Parameters
{
"data": {
"type": "account",
"attributes": {
"name": "Rocket Rides",
"default_tts_voice": "Basic.Kal",
"billing_enabled": true,
"billing_mode": "prepaid",
"metadata": {
"foo": "bar"
}
}
}
}
| Name | Description |
|---|---|
| data[attributes][name] required | A friendly name which identifies the account |
| data[attributes][billing_enabled] | Enable billing for the account. Defaults to false. |
| data[attributes][billing_mode] | The billing mode for the account. Only prepaid is supported at this time. |
| data[attributes][tts_voice] | The default TTS voice identifier. Defaults to: Basic.Kal |
| data[attributes][metadata] | Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. |
Response
201 Created
{
"data": {
"id": "9d3da378-911e-4ad2-b37f-cac2e271cfbb",
"type": "account",
"attributes": {
"created_at": "2026-11-13T08:31:06Z",
"updated_at": "2026-11-13T08:31:06Z",
"name": "Rocket Rides",
"metadata": {
"foo": "bar"
},
"status": "enabled",
"type": "carrier_managed",
"billing_enabled": true,
"billing_mode": "prepaid",
"auth_token": "oyMQXi0YArNkcKDl3SbiFL3veSBMGUB7jaiVRnd-kcc",
"default_tts_voice": "Basic.Kal"
}
}
}
Delete an account
Request
curl "https://api.somleng.org/carrier/v1/accounts/219ef9a2-8a86-402b-adac-e4a55fc66d59" -d '' -X DELETE \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer RWMQ6mgClqQatHjh5UXLTUl3t-PSjbsEjnLnrMOMKkE"
Endpoint
DELETE https://api.somleng.org/carrier/v1/accounts/:id
DELETE https://api.somleng.org/carrier/v1/accounts/219ef9a2-8a86-402b-adac-e4a55fc66d59
Parameters
None known.
Response
204 No Content
List all accounts
Request
curl "https://api.somleng.org/carrier/v1/accounts" \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer 3QN4psp54Km0ioIUJPdagm-6O7MlT3nrlj8dz8TRt_c"
Endpoint
GET https://api.somleng.org/carrier/v1/accounts
GET https://api.somleng.org/carrier/v1/accounts
Parameters
None known.
Response
200 OK
{
"data": [
{
"id": "193b2513-83d6-40c1-b75b-100c710aea2b",
"type": "account",
"attributes": {
"created_at": "2026-11-13T08:31:06Z",
"updated_at": "2026-11-13T08:31:06Z",
"name": "Telco Net",
"metadata": {},
"status": "enabled",
"type": "carrier_managed",
"billing_enabled": false,
"billing_mode": "prepaid",
"auth_token": "zY4ZpvQi4gcIQvKYe31qWlWratO8XEITv09AljbqTqU",
"default_tts_voice": "Basic.Kal"
}
},
{
"id": "025b67d7-d784-49c0-9dfd-d51ae06f8009",
"type": "account",
"attributes": {
"created_at": "2026-11-13T08:31:06Z",
"updated_at": "2026-11-13T08:31:06Z",
"name": "Rocket Rides",
"metadata": {},
"status": "enabled",
"type": "customer_managed",
"billing_enabled": false,
"billing_mode": "prepaid",
"default_tts_voice": "Basic.Kal"
}
}
],
"links": {
"prev": "https://api.somleng.org/carrier/v1/accounts?page%5Bbefore%5D=193b2513-83d6-40c1-b75b-100c710aea2b",
"next": null
}
}
Retrieve an account
Request
curl "https://api.somleng.org/carrier/v1/accounts/38b41a37-f2e3-499f-9deb-0612e5b51210" \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer 1fJJlOpA2eez3CWDJ4jX0TMdyOAroSHqe9h9fcoUZu4"
Endpoint
GET https://api.somleng.org/carrier/v1/accounts/:id
GET https://api.somleng.org/carrier/v1/accounts/38b41a37-f2e3-499f-9deb-0612e5b51210
Parameters
| Name | Description |
|---|---|
| id required | The id of the account to be retrieved. |
Response
200 OK
{
"data": {
"id": "38b41a37-f2e3-499f-9deb-0612e5b51210",
"type": "account",
"attributes": {
"created_at": "2026-11-13T08:31:06Z",
"updated_at": "2026-11-13T08:31:06Z",
"name": "Rocket Rides",
"metadata": {},
"status": "enabled",
"type": "carrier_managed",
"billing_enabled": false,
"billing_mode": "prepaid",
"auth_token": "d-Ukls0L2dmMYGNNIVun69OV0YawAoKTZcl81e35UwU",
"default_tts_voice": "Basic.Kal"
}
}
}
Update an account
Request
curl "https://api.somleng.org/carrier/v1/accounts/c5c078ae-c71d-4067-99ed-dec0b2455445" -d '{
"data": {
"attributes": {
"status": null,
"name": "Bob Cats",
"status": "disabled",
"billing_enabled": false,
"default_tts_voice": "Basic.Kal",
"metadata": {
"bar": "foo"
}
},
"type": "account",
"id": "c5c078ae-c71d-4067-99ed-dec0b2455445"
}
}' -X PATCH \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer d01mBXecNn_zx_GbH2NJgeyFW0i_jq-1ictm3YG3Hsg"
Endpoint
PATCH https://api.somleng.org/carrier/v1/accounts/:id
PATCH https://api.somleng.org/carrier/v1/accounts/c5c078ae-c71d-4067-99ed-dec0b2455445
Parameters
{
"data": {
"attributes": {
"status": null,
"name": "Bob Cats",
"status": "disabled",
"billing_enabled": false,
"default_tts_voice": "Basic.Kal",
"metadata": {
"bar": "foo"
}
},
"type": "account",
"id": "c5c078ae-c71d-4067-99ed-dec0b2455445"
}
}
| Name | Description |
|---|---|
| data[attributes][status] | Update the status of the account. One of either enabled or disabled. |
Response
200 OK
{
"data": {
"id": "c5c078ae-c71d-4067-99ed-dec0b2455445",
"type": "account",
"attributes": {
"created_at": "2026-11-13T08:31:06Z",
"updated_at": "2026-11-13T08:31:06Z",
"name": "Bob Cats",
"metadata": {
"foo": "bar",
"bar": "foo"
},
"status": "disabled",
"type": "carrier_managed",
"billing_enabled": false,
"billing_mode": "prepaid",
"auth_token": "P3KPT_3-bjhG-6b25NcCQqFWiTIpVFPY6X2WxNLFrjY",
"default_tts_voice": "Basic.Kal"
}
}
}
Events
List all events
Types of events
This is a list of all the types of events we currently send. We may add more at any time, so in developing and maintaining your code, you should not assume that only these types exist.
You'll notice that these events follow a pattern: resource.event.
Our goal is to design a consistent system that makes things easier to anticipate and code against.
| Event |
|---|
phone_call.completed |
message.sent |
message.delivered |
Request
curl "https://api.somleng.org/carrier/v1/events" \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer eP4JGcRJbLeiGoDFZCDTGVV47PQGnsJPMq1WQ0WgA84"
Endpoint
GET https://api.somleng.org/carrier/v1/events
GET https://api.somleng.org/carrier/v1/events
Parameters
None known.
Response
200 OK
{
"data": [
{
"id": "484c9137-e9e2-4302-a3d3-265eb31aeb9e",
"type": "event",
"attributes": {
"created_at": "2026-11-13T08:30:19Z",
"updated_at": "2026-11-13T08:30:19Z",
"type": "phone_call.completed",
"details": {
"data": {
"id": "fa6e7fd1-1043-4d4a-879d-c7915cb7a5f5",
"type": "phone_call",
"attributes": {
"to": "+85512334667",
"from": "2442",
"price": null,
"status": "queued",
"duration": null,
"direction": "outbound-api",
"created_at": "2026-11-13T08:30:19Z",
"price_unit": null,
"updated_at": "2026-11-13T08:30:19Z"
},
"relationships": {
"account": {
"data": {
"id": "00e3f2eb-97e9-4068-b4ba-0c38432413b2",
"type": "account"
}
}
}
}
}
}
}
],
"links": {
"prev": "https://api.somleng.org/carrier/v1/events?page%5Bbefore%5D=484c9137-e9e2-4302-a3d3-265eb31aeb9e",
"next": null
}
}
Retrieve an Event
Request
curl "https://api.somleng.org/carrier/v1/events/7bb323c9-bd3d-4dc3-aed5-c7ceb67a5d73" \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer dMBdbfpuW8EF2gzysxJSKNvSo7CNGfjIbLWqORLdcH8"
Endpoint
GET https://api.somleng.org/carrier/v1/events/:id
GET https://api.somleng.org/carrier/v1/events/7bb323c9-bd3d-4dc3-aed5-c7ceb67a5d73
Parameters
None known.
Response
200 OK
{
"data": {
"id": "7bb323c9-bd3d-4dc3-aed5-c7ceb67a5d73",
"type": "event",
"attributes": {
"created_at": "2026-11-13T08:30:19Z",
"updated_at": "2026-11-13T08:30:19Z",
"type": "phone_call.completed",
"details": {
"data": {
"id": "e2faed47-39f9-487e-86cf-ff23fe506633",
"type": "phone_call",
"attributes": {
"to": "+85512334667",
"from": "2442",
"price": null,
"status": "queued",
"duration": null,
"direction": "outbound-api",
"created_at": "2026-11-13T08:30:19Z",
"price_unit": null,
"updated_at": "2026-11-13T08:30:19Z"
},
"relationships": {
"account": {
"data": {
"id": "6d45c649-4bbd-4d79-8879-4da24284ec39",
"type": "account"
}
}
}
}
}
}
}
}
Messages
List messages
Request
curl "https://api.somleng.org/carrier/v1/messages?filter[status]=sent&filter[from_date]=2021-11-01T00%3A00%3A00Z&filter[to_date]=2021-11-01T00%3A00%3A00Z&filter[account]=b335fd1a-1308-4e12-88bb-9da5f36530f5&filter[direction]=outbound-api" \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer jo0h7-lTaz9Zar8oCZN37eKIjWx8CwokgrUPnScWn6M"
Endpoint
GET https://api.somleng.org/carrier/v1/messages
GET https://api.somleng.org/carrier/v1/messages?filter[status]=sent&filter[from_date]=2021-11-01T00%3A00%3A00Z&filter[to_date]=2021-11-01T00%3A00%3A00Z&filter[account]=b335fd1a-1308-4e12-88bb-9da5f36530f5&filter[direction]=outbound-api
Parameters
{
"filter": {
"status": "sent",
"from_date": "2021-11-01T00:00:00Z",
"to_date": "2021-11-01T00:00:00Z",
"account": "b335fd1a-1308-4e12-88bb-9da5f36530f5",
"direction": "outbound-api"
}
}
| Name | Description |
|---|---|
| filter[account] | Return messages from the provided account-sid |
| filter[from_date] | Return messages on or after the provided date/time in ISO 8601 format. |
| filter[to_date] | Return messages on or before the provided date/time in ISO 8601 format. |
| filter[direction] | One of inbound, outbound-api, outbound-call, outbound-reply, and outbound |
| filter[status] | One of accepted, scheduled, queued, sending, sent, failed, received, canceled, and delivered |
Response
200 OK
{
"data": [
{
"id": "c08e8485-345d-432f-aea0-1df583de1691",
"type": "message",
"attributes": {
"created_at": "2021-11-01T01:00:00Z",
"updated_at": "2026-11-13T08:30:38Z",
"to": "+85512334667",
"from": "2442",
"price_unit": null,
"direction": "outbound-api",
"status": "sent",
"body": "Hello World",
"price": null
},
"relationships": {
"account": {
"data": {
"id": "b335fd1a-1308-4e12-88bb-9da5f36530f5",
"type": "account"
}
}
}
}
],
"links": {
"prev": "https://api.somleng.org/carrier/v1/messages?filter%5Baccount%5D=b335fd1a-1308-4e12-88bb-9da5f36530f5&filter%5Bdirection%5D=outbound-api&filter%5Bfrom_date%5D=2021-11-01T00%3A00%3A00Z&filter%5Bstatus%5D=sent&filter%5Bto_date%5D=2021-11-01T00%3A00%3A00Z&page%5Bbefore%5D=c08e8485-345d-432f-aea0-1df583de1691",
"next": null
}
}
Retrieve a message
Request
curl "https://api.somleng.org/carrier/v1/messages/76fa42fb-7e60-412e-985f-1ecb722d26c4" \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer QGkWThOJyiwDi2Wj7bKrSl0wqaFCkF4Yn3GvimtvJe8"
Endpoint
GET https://api.somleng.org/carrier/v1/messages/:id
GET https://api.somleng.org/carrier/v1/messages/76fa42fb-7e60-412e-985f-1ecb722d26c4
Parameters
None known.
Response
200 OK
{
"data": {
"id": "76fa42fb-7e60-412e-985f-1ecb722d26c4",
"type": "message",
"attributes": {
"created_at": "2026-11-13T08:30:39Z",
"updated_at": "2026-11-13T08:30:39Z",
"to": "+85512334667",
"from": "2442",
"price_unit": null,
"direction": "outbound-api",
"status": "accepted",
"body": "Hello World",
"price": null
},
"relationships": {
"account": {
"data": {
"id": "29baf7a3-a4ab-4fb8-8acd-ab593fe4acb1",
"type": "account"
}
}
}
}
}
Update a message
Request
curl "https://api.somleng.org/carrier/v1/messages/079dffa7-4665-4441-88f8-411b915c64fe" -d '{
"data": {
"id": "079dffa7-4665-4441-88f8-411b915c64fe",
"type": "message",
"attributes": {
"price": "-0.05"
}
}
}' -X PATCH \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer cQhUFgDpnd8wLSTA5UqbYJErq6yvt_4qJb3_9BUdrwk"
Endpoint
PATCH https://api.somleng.org/carrier/v1/messages/:id
PATCH https://api.somleng.org/carrier/v1/messages/079dffa7-4665-4441-88f8-411b915c64fe
Parameters
{
"data": {
"id": "079dffa7-4665-4441-88f8-411b915c64fe",
"type": "message",
"attributes": {
"price": "-0.05"
}
}
}
| Name | Description |
|---|---|
| data[attributes][price] | The charge for this call in the account's billing currency |
Response
200 OK
{
"data": {
"id": "079dffa7-4665-4441-88f8-411b915c64fe",
"type": "message",
"attributes": {
"created_at": "2026-11-13T08:30:39Z",
"updated_at": "2026-11-13T08:30:39Z",
"to": "+85512334667",
"from": "2442",
"price_unit": "USD",
"direction": "outbound-api",
"status": "sent",
"body": "Hello World",
"price": "-0.05000"
},
"relationships": {
"account": {
"data": {
"id": "61d242e2-3b86-419d-82d8-d9d6f3aa4a16",
"type": "account"
}
}
}
}
}
Phone Calls
List phone calls
Request
curl "https://api.somleng.org/carrier/v1/phone_calls?filter[status]=queued&filter[from_date]=2021-11-01T00%3A00%3A00Z&filter[to_date]=2021-11-01T00%3A00%3A00Z&filter[account]=e6c12577-d038-4f58-b879-33dee87a5b39&filter[direction]=outbound-api" \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer JeUM24l-MXNneH7QvPScXhbbUQSiXun0-GvVYwd0rYA"
Endpoint
GET https://api.somleng.org/carrier/v1/phone_calls
GET https://api.somleng.org/carrier/v1/phone_calls?filter[status]=queued&filter[from_date]=2021-11-01T00%3A00%3A00Z&filter[to_date]=2021-11-01T00%3A00%3A00Z&filter[account]=e6c12577-d038-4f58-b879-33dee87a5b39&filter[direction]=outbound-api
Parameters
{
"filter": {
"status": "queued",
"from_date": "2021-11-01T00:00:00Z",
"to_date": "2021-11-01T00:00:00Z",
"account": "e6c12577-d038-4f58-b879-33dee87a5b39",
"direction": "outbound-api"
}
}
| Name | Description |
|---|---|
| filter[account] | Return phone calls from the provided account-sid |
| filter[from_date] | Return phone calls on or after the provided date/time in ISO 8601 format. |
| filter[to_date] | Return phone calls on or before the provided date/time in ISO 8601 format. |
| filter[direction] | One of inbound, outbound-api, and outbound-dial |
| filter[status] | One of queued, ringing, in-progress, busy, failed, no-answer, completed, and canceled |
Response
200 OK
{
"data": [
{
"id": "359b3e42-349c-472e-90a7-eb248f880d7c",
"type": "phone_call",
"attributes": {
"created_at": "2021-11-01T01:00:00Z",
"updated_at": "2026-11-13T08:31:15Z",
"to": "+85512334667",
"from": "2442",
"price_unit": null,
"duration": null,
"direction": "outbound-api",
"status": "queued",
"price": null
},
"relationships": {
"account": {
"data": {
"id": "e6c12577-d038-4f58-b879-33dee87a5b39",
"type": "account"
}
}
}
}
],
"links": {
"prev": "https://api.somleng.org/carrier/v1/phone_calls?filter%5Baccount%5D=e6c12577-d038-4f58-b879-33dee87a5b39&filter%5Bdirection%5D=outbound-api&filter%5Bfrom_date%5D=2021-11-01T00%3A00%3A00Z&filter%5Bstatus%5D=queued&filter%5Bto_date%5D=2021-11-01T00%3A00%3A00Z&page%5Bbefore%5D=359b3e42-349c-472e-90a7-eb248f880d7c",
"next": null
}
}
Retrieve a phone call
Request
curl "https://api.somleng.org/carrier/v1/phone_calls/dd5c53d6-ef7e-4b96-be4f-e73c6c9c5584" \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer eLJ0NxNvBo3D3oeT7Dz_-xUfLVzM12dA7ZknQOx5rIM"
Endpoint
GET https://api.somleng.org/carrier/v1/phone_calls/:id
GET https://api.somleng.org/carrier/v1/phone_calls/dd5c53d6-ef7e-4b96-be4f-e73c6c9c5584
Parameters
None known.
Response
200 OK
{
"data": {
"id": "dd5c53d6-ef7e-4b96-be4f-e73c6c9c5584",
"type": "phone_call",
"attributes": {
"created_at": "2026-11-13T08:31:15Z",
"updated_at": "2026-11-13T08:31:15Z",
"to": "+85512334667",
"from": "2442",
"price_unit": null,
"duration": null,
"direction": "outbound-api",
"status": "queued",
"price": null
},
"relationships": {
"account": {
"data": {
"id": "508d69d4-9489-4f4d-90ee-e5f4a53cd4df",
"type": "account"
}
}
}
}
}
Update a phone call
Request
curl "https://api.somleng.org/carrier/v1/phone_calls/ac9d4642-955a-4002-bf9b-0c1f695813ca" -d '{
"data": {
"id": "ac9d4642-955a-4002-bf9b-0c1f695813ca",
"type": "phone_call",
"attributes": {
"price": "-0.05"
}
}
}' -X PATCH \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer FVrRPK8LtCSwwz7kvli6P8O3Q5DT8QtWFJnhyHVMlSI"
Endpoint
PATCH https://api.somleng.org/carrier/v1/phone_calls/:id
PATCH https://api.somleng.org/carrier/v1/phone_calls/ac9d4642-955a-4002-bf9b-0c1f695813ca
Parameters
{
"data": {
"id": "ac9d4642-955a-4002-bf9b-0c1f695813ca",
"type": "phone_call",
"attributes": {
"price": "-0.05"
}
}
}
| Name | Description |
|---|---|
| data[attributes][price] | The charge for this call in the account's billing currency |
Response
200 OK
{
"data": {
"id": "ac9d4642-955a-4002-bf9b-0c1f695813ca",
"type": "phone_call",
"attributes": {
"created_at": "2026-11-13T08:31:15Z",
"updated_at": "2026-11-13T08:31:15Z",
"to": "+85512334667",
"from": "2442",
"price_unit": "USD",
"duration": "5",
"direction": "outbound-api",
"status": "completed",
"price": "-0.05000"
},
"relationships": {
"account": {
"data": {
"id": "11915c2a-4acf-4bb7-a0d9-3bf43460c42c",
"type": "account"
}
}
}
}
}
Phone Numbers
01. Create a phone number
Request
curl "https://api.somleng.org/carrier/v1/phone_numbers" -d '{
"data": {
"type": "phone_number",
"attributes": {
"number": "1294",
"type": "short_code",
"metadata": {
"my_custom_field": "my_custom_field_value"
}
}
}
}' -X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer F1z3Ofujz1hQhCF_lhrc4409oadP-USML1UibWAKTAE"
Endpoint
POST https://api.somleng.org/carrier/v1/phone_numbers
POST https://api.somleng.org/carrier/v1/phone_numbers
Parameters
{
"data": {
"type": "phone_number",
"attributes": {
"number": "1294",
"type": "short_code",
"metadata": {
"my_custom_field": "my_custom_field_value"
}
}
}
}
| Name | Description |
|---|---|
| data[attributes][number] required | Phone number in E.164 format or shortcode. |
| data[attributes][type] required | The type of the phone number. Must be one of short_code, local, mobile, toll_free. |
| data[attributes][visibility] | The visibility of the phone number. Must be one of private, public, disabled. Defaults to public for phone numbers with a price and private for phone numbers without one |
| data[attributes][country] | The ISO 3166-1 alpha-2 country code of the phone number. If not specified, it's automatically resolved from the number parameter, or defaults to the carrier's country code if unresolvable. |
| data[attributes][price] | The price for the phone number in the billing currency of the carrier. |
| data[attributes][region] | The state or province abbreviation of this phone number's location. |
| data[attributes][locality] | The locality or city of this phone number's location. |
| data[attributes][lata] | The LATA of this phone number. Applicable only to phone numbers from the US and Canada. |
| data[attributes][rate_center] | The rate center of this phone number. Applicable only to phone numbers from the US and Canada. |
| data[attributes][latitude] | The latitude of this phone number's location. Applicable only for phone numbers from the US and Canada. |
| data[attributes][longitude] | The longitude of this phone number's location. Applicable only for phone numbers from the US and Canada. |
| data[attributes][metadata] | Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. |
Response
201 Created
{
"data": {
"id": "574f39be-043f-4dd9-9d2e-88ec34a7f888",
"type": "phone_number",
"attributes": {
"created_at": "2026-11-13T08:30:58Z",
"updated_at": "2026-11-13T08:30:58Z",
"number": "1294",
"country": "KH",
"visibility": "private",
"type": "short_code",
"locality": null,
"rate_center": null,
"lata": null,
"latitude": null,
"longitude": null,
"metadata": {
"my_custom_field": "my_custom_field_value"
},
"currency": "KHR",
"price": "0.00",
"region": null
}
}
}
02. Update a phone number
Request
curl "https://api.somleng.org/carrier/v1/phone_numbers/b45ee7b8-078d-4b7f-af19-7ac89bbff207" -d '{
"data": {
"type": "phone_number",
"id": "b45ee7b8-078d-4b7f-af19-7ac89bbff207",
"attributes": {
"type": "mobile",
"visibility": "public",
"country": "US",
"price": "1.15",
"region": "AR",
"locality": "Little Rock",
"rate_center": "LITTLEROCK",
"lata": "528",
"latitude": "34.748463",
"longitude": "-92.284434",
"metadata": {
"my_custom_field": "my_custom_field_value"
}
}
}
}' -X PATCH \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer DcqFm1KewlZjEkL9EgC3gIyP2kePgrwuFXl_6fp_v_I"
Endpoint
PATCH https://api.somleng.org/carrier/v1/phone_numbers/:id
PATCH https://api.somleng.org/carrier/v1/phone_numbers/b45ee7b8-078d-4b7f-af19-7ac89bbff207
Parameters
{
"data": {
"type": "phone_number",
"id": "b45ee7b8-078d-4b7f-af19-7ac89bbff207",
"attributes": {
"type": "mobile",
"visibility": "public",
"country": "US",
"price": "1.15",
"region": "AR",
"locality": "Little Rock",
"rate_center": "LITTLEROCK",
"lata": "528",
"latitude": "34.748463",
"longitude": "-92.284434",
"metadata": {
"my_custom_field": "my_custom_field_value"
}
}
}
}
| Name | Description |
|---|---|
| data[attributes][type] | The type of the phone number. Must be one of short_code, local, mobile, toll_free. |
| data[attributes][visibility] | The visibility of the phone number. Must be one of private, public, disabled. Defaults to public for phone numbers with a price and private for phone numbers without one |
| data[attributes][country] | The ISO 3166-1 alpha-2 country code of the phone number. If not specified, it's automatically resolved from the number parameter, or defaults to the carrier's country code if unresolvable. |
| data[attributes][price] | The price for the phone number in the billing currency of the carrier. |
| data[attributes][region] | The state or province abbreviation of this phone number's location. |
| data[attributes][locality] | The locality or city of this phone number's location. |
| data[attributes][lata] | The LATA of this phone number. Applicable only to phone numbers from the US and Canada. |
| data[attributes][rate_center] | The rate center of this phone number. Applicable only to phone numbers from the US and Canada. |
| data[attributes][latitude] | The latitude of this phone number's location. Applicable only for phone numbers from the US and Canada. |
| data[attributes][longitude] | The longitude of this phone number's location. Applicable only for phone numbers from the US and Canada. |
| data[attributes][metadata] | Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. |
Response
200 OK
{
"data": {
"id": "b45ee7b8-078d-4b7f-af19-7ac89bbff207",
"type": "phone_number",
"attributes": {
"created_at": "2026-11-13T08:30:58Z",
"updated_at": "2026-11-13T08:30:58Z",
"number": "+15067020972",
"country": "US",
"visibility": "public",
"type": "mobile",
"locality": "Little Rock",
"rate_center": "LITTLEROCK",
"lata": "528",
"latitude": "34.748463",
"longitude": "-92.284434",
"metadata": {
"my_custom_field": "my_custom_field_value"
},
"currency": "CAD",
"price": "1.15",
"region": "AR"
}
}
}
03. Retrieve a phone number
Request
curl "https://api.somleng.org/carrier/v1/phone_numbers/8f9b9af0-ec31-43e0-9cfe-b205d7faacb6" \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer MdxCdm7-9Z4MFfUTqOgjSabMipXHuZv18cSH0iw9blc"
Endpoint
GET https://api.somleng.org/carrier/v1/phone_numbers/:id
GET https://api.somleng.org/carrier/v1/phone_numbers/8f9b9af0-ec31-43e0-9cfe-b205d7faacb6
Parameters
None known.
Response
200 OK
{
"data": {
"id": "8f9b9af0-ec31-43e0-9cfe-b205d7faacb6",
"type": "phone_number",
"attributes": {
"created_at": "2026-11-13T08:30:58Z",
"updated_at": "2026-11-13T08:30:58Z",
"number": "+855972345817",
"country": "KH",
"visibility": "private",
"type": "mobile",
"locality": null,
"rate_center": null,
"lata": null,
"latitude": null,
"longitude": null,
"metadata": {},
"currency": "KHR",
"price": "0.00",
"region": null
}
}
}
04. List all phone numbers
Request
curl "https://api.somleng.org/carrier/v1/phone_numbers" \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer nRnMKovXcyclUiSzde4Q2auDiA6KUfvdevFY66S1UJc"
Endpoint
GET https://api.somleng.org/carrier/v1/phone_numbers
GET https://api.somleng.org/carrier/v1/phone_numbers
Parameters
None known.
Response
200 OK
{
"data": [
{
"id": "3f7ecfaa-e4d8-4dd6-bce2-61eb08ee8d89",
"type": "phone_number",
"attributes": {
"created_at": "2026-11-13T08:30:58Z",
"updated_at": "2026-11-13T08:30:58Z",
"number": "+855972345819",
"country": "KH",
"visibility": "private",
"type": "mobile",
"locality": null,
"rate_center": null,
"lata": null,
"latitude": null,
"longitude": null,
"metadata": {},
"currency": "KHR",
"price": "0.00",
"region": null
}
},
{
"id": "2d943aec-aae1-412c-b434-a4cfc93abb11",
"type": "phone_number",
"attributes": {
"created_at": "2026-11-13T08:30:58Z",
"updated_at": "2026-11-13T08:30:58Z",
"number": "+855972345818",
"country": "KH",
"visibility": "private",
"type": "mobile",
"locality": null,
"rate_center": null,
"lata": null,
"latitude": null,
"longitude": null,
"metadata": {},
"currency": "KHR",
"price": "0.00",
"region": null
}
}
],
"links": {
"prev": "https://api.somleng.org/carrier/v1/phone_numbers?page%5Bbefore%5D=3f7ecfaa-e4d8-4dd6-bce2-61eb08ee8d89",
"next": null
}
}
05. Delete a phone number
Request
curl "https://api.somleng.org/carrier/v1/phone_numbers/3629eb30-4882-4ef4-9112-c77352c09640" -d '' -X DELETE \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer 57gvM4llPSUV31Z45mCWWGzq6k9WucH46TfxMsGKOJE"
Endpoint
DELETE https://api.somleng.org/carrier/v1/phone_numbers/:id
DELETE https://api.somleng.org/carrier/v1/phone_numbers/3629eb30-4882-4ef4-9112-c77352c09640
Parameters
None known.
Response
204 No Content
06. Get number of available phone numbers per locality having a count less than 2
Request
curl "https://api.somleng.org/carrier/v1/phone_numbers/stats?filter[available]=true&filter[type]=local&group_by[]=country&group_by[]=region&group_by[]=locality&having[count][lt]=2" \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer b_9btBlF6M4G_5R4B756VNPXqMPuemjMn--lLD7nlPY"
Endpoint
GET https://api.somleng.org/carrier/v1/phone_numbers/stats
GET https://api.somleng.org/carrier/v1/phone_numbers/stats?filter[available]=true&filter[type]=local&group_by[]=country&group_by[]=region&group_by[]=locality&having[count][lt]=2
Parameters
{
"filter": {
"available": "true",
"type": "local"
},
"group_by": [
"country",
"region",
"locality"
],
"having": {
"count": {
"lt": "2"
}
}
}
| Name | Description |
|---|---|
| filter[available] required | Return only available phone numbers. Must be true |
| filter[type] required | The phone number type. Must be local |
| filter[country] | The ISO country code. E.g. US |
| filter[region] | The ISO region code. E.g. AR |
| filter[locality] | The locality or city name. e.g. Little Rock |
| group_by required | An array of fields to group by. Must be ['country', 'region', 'locality'] |
| having[count][operator] | One of eq, neq, gt, gteq, lt, lteq |
| having[count][value] | The value of the count. Must be an integer greater than or equal to 0 |
Response
200 OK
{
"data": [
{
"id": "2e02a6de3fa86617dec16e762a756a2fc82f7f474215485effa2577b1a869e64",
"type": "aggregate_data",
"attributes": {
"statistic": {
"country": "US",
"region": "AL",
"locality": "Birmingham",
"value": 1
}
}
},
{
"id": "dbcd7a4b79acfdbeb7bc78dfcded1098b8a5b0ca1cb63619ae65864b89162520",
"type": "aggregate_data",
"attributes": {
"statistic": {
"country": "US",
"region": "AL",
"locality": "Huntsville",
"value": 1
}
}
},
{
"id": "7bb81870f4f3d4a6756f30d8a4ecbf98c0da08ec74cae4af760843e07bee7ec6",
"type": "aggregate_data",
"attributes": {
"statistic": {
"country": "US",
"region": "AL",
"locality": "Tuscaloosa",
"value": 1
}
}
},
{
"id": "f0e41da727a633bc8890195abcfb907391e664682d2da4cbd0a14f5e520bb7f4",
"type": "aggregate_data",
"attributes": {
"statistic": {
"country": "US",
"region": "AR",
"locality": "Hot Springs",
"value": 1
}
}
},
{
"id": "79adb2a2fce5c6ba215fe5f27f532d4e7edbac4b6a5e09e1ef3a08084a904621",
"type": "aggregate_data",
"attributes": {
"statistic": {
"country": "US",
"region": null,
"locality": null,
"value": 1
}
}
}
],
"links": {
"prev": "https://api.somleng.org/carrier/v1/phone_numbers/stats?filter%5Bavailable%5D=true&filter%5Btype%5D=local&group_by%5B%5D=country&group_by%5B%5D=region&group_by%5B%5D=locality&having%5Bcount%5D%5Blt%5D=2&page%5Bbefore%5D=2e02a6de3fa86617dec16e762a756a2fc82f7f474215485effa2577b1a869e64",
"next": null
}
}
TTS Events
List all TTS events
Request
curl "https://api.somleng.org/carrier/v1/tts_events?filter[from_date]=2026-11-12&filter[account]=31f76f99-8349-4b42-a215-40504ef972b3&filter[phone_call]=22ff7d60-6651-46ee-b81d-97015d745f64" \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer o_WFqW8nWw7yrk_-SLuC3n16w4JI7GgY3O0tpr46PTE"
Endpoint
GET https://api.somleng.org/carrier/v1/tts_events
GET https://api.somleng.org/carrier/v1/tts_events?filter[from_date]=2026-11-12&filter[account]=31f76f99-8349-4b42-a215-40504ef972b3&filter[phone_call]=22ff7d60-6651-46ee-b81d-97015d745f64
Parameters
{
"filter": {
"from_date": "2026-11-12",
"account": "31f76f99-8349-4b42-a215-40504ef972b3",
"phone_call": "22ff7d60-6651-46ee-b81d-97015d745f64"
}
}
| Name | Description |
|---|---|
| filter[account] | Return TTS Events from the provided account SID |
| filter[phone_call] | Return TTS Events from the provided phone call SID |
| filter[from_date] | Return TTS events on or after the provided date/time in ISO 8601 format. |
| filter[to_date] | Return TTS events on or before the provided date/time in ISO 8601 format. |
Response
200 OK
{
"data": [
{
"id": "41f8f681-e7f2-4496-b395-d0b668e2722b",
"type": "tts_event",
"attributes": {
"created_at": "2026-11-13T08:30:36Z",
"updated_at": "2026-11-13T08:30:36Z",
"voice": "Basic.Kal (Male, en-US)",
"characters": 200
},
"relationships": {
"account": {
"data": {
"id": "31f76f99-8349-4b42-a215-40504ef972b3",
"type": "account"
}
},
"phone_call": {
"data": {
"id": "22ff7d60-6651-46ee-b81d-97015d745f64",
"type": "phone_call"
}
}
}
},
{
"id": "96630e1e-8360-43d1-b2fa-47ab3f68aa27",
"type": "tts_event",
"attributes": {
"created_at": "2026-11-13T08:30:36Z",
"updated_at": "2026-11-13T08:30:36Z",
"voice": "Basic.Kal (Male, en-US)",
"characters": 100
},
"relationships": {
"account": {
"data": {
"id": "31f76f99-8349-4b42-a215-40504ef972b3",
"type": "account"
}
},
"phone_call": {
"data": {
"id": "22ff7d60-6651-46ee-b81d-97015d745f64",
"type": "phone_call"
}
}
}
}
],
"links": {
"prev": "https://api.somleng.org/carrier/v1/tts_events?filter%5Baccount%5D=31f76f99-8349-4b42-a215-40504ef972b3&filter%5Bfrom_date%5D=2026-11-12&filter%5Bphone_call%5D=22ff7d60-6651-46ee-b81d-97015d745f64&page%5Bbefore%5D=41f8f681-e7f2-4496-b395-d0b668e2722b",
"next": null
}
}
Retrieve a TTS Event
Request
curl "https://api.somleng.org/carrier/v1/tts_events/c3d2487a-5322-4340-931b-3725e6202c4b" \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer TuvjbajKYVRLIoc6mExvf4MoYE3XI-jsnC8gmBtt11o"
Endpoint
GET https://api.somleng.org/carrier/v1/tts_events/:id
GET https://api.somleng.org/carrier/v1/tts_events/c3d2487a-5322-4340-931b-3725e6202c4b
Parameters
None known.
Response
200 OK
{
"data": {
"id": "c3d2487a-5322-4340-931b-3725e6202c4b",
"type": "tts_event",
"attributes": {
"created_at": "2026-11-13T08:30:36Z",
"updated_at": "2026-11-13T08:30:36Z",
"voice": "Basic.Kal (Male, en-US)",
"characters": 100
},
"relationships": {
"account": {
"data": {
"id": "27e4b5de-d273-470c-b077-294262625d9c",
"type": "account"
}
},
"phone_call": {
"data": {
"id": "a94f27fe-5062-4d92-943a-4f4e70c3319e",
"type": "phone_call"
}
}
}
}
}