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",
"metadata": {
"foo": "bar"
}
}
}
}' -X POST \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer iQvh4J8EsvAmX44oDCrsirobJjo6RSykMhalD1s4tGY"
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",
"metadata": {
"foo": "bar"
}
}
}
}
| Name | Description |
|---|---|
| data[attributes][name] required | A friendly name which identifies the account |
| 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": "6151eb1a-488e-4eb1-88aa-da89f001b8eb",
"type": "account",
"attributes": {
"created_at": "2025-04-27T06:03:10Z",
"updated_at": "2025-04-27T06:03:10Z",
"name": "Rocket Rides",
"metadata": {
"foo": "bar"
},
"status": "enabled",
"type": "carrier_managed",
"auth_token": "tu951ilgZxGqAlcElk82cXO9DbvmqnLrXcVyD9w1P1w",
"default_tts_voice": "Basic.Kal"
}
}
}
Delete an account
Request
curl "https://api.somleng.org/carrier/v1/accounts/98c42c18-06e2-4264-8350-0b14ed776f6d" -d '' -X DELETE \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer 3Kf_TVtQvLOtNPpZxTpxXouiy-VTA3c4sB08dFltkh4"
Endpoint
DELETE https://api.somleng.org/carrier/v1/accounts/:id
DELETE https://api.somleng.org/carrier/v1/accounts/98c42c18-06e2-4264-8350-0b14ed776f6d
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 bov4vX3d1tRG4lAuHuxECXR-JbL_ys7teti1iVe4ZmQ"
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": "426e5bd7-a067-44f4-ad88-af8f80df07df",
"type": "account",
"attributes": {
"created_at": "2025-04-27T06:03:10Z",
"updated_at": "2025-04-27T06:03:10Z",
"name": "Telco Net",
"metadata": {},
"status": "enabled",
"type": "carrier_managed",
"auth_token": "qVdaPCE8tkphR-Ip6fKV1DXoi4_YREcsMZN9bnM6jjM",
"default_tts_voice": "Basic.Kal"
}
},
{
"id": "1c08ea89-ff4d-4e4b-a2bb-85864787fb69",
"type": "account",
"attributes": {
"created_at": "2025-04-27T06:03:10Z",
"updated_at": "2025-04-27T06:03:10Z",
"name": "Rocket Rides",
"metadata": {},
"status": "enabled",
"type": "customer_managed",
"default_tts_voice": "Basic.Kal"
}
}
],
"links": {
"prev": "https://api.somleng.org/carrier/v1/accounts?page%5Bbefore%5D=426e5bd7-a067-44f4-ad88-af8f80df07df",
"next": null
}
}
Retrieve an account
Request
curl "https://api.somleng.org/carrier/v1/accounts/b96163dc-e85a-4d5a-a49b-df4a5f2c24a3" \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer Fc2M1-G59lClmRL9rE-UaDlgFM5h8b1bu2hVI47yCAs"
Endpoint
GET https://api.somleng.org/carrier/v1/accounts/:id
GET https://api.somleng.org/carrier/v1/accounts/b96163dc-e85a-4d5a-a49b-df4a5f2c24a3
Parameters
| Name | Description |
|---|---|
| id required | The id of the account to be retrieved. |
Response
200 OK
{
"data": {
"id": "b96163dc-e85a-4d5a-a49b-df4a5f2c24a3",
"type": "account",
"attributes": {
"created_at": "2025-04-27T06:03:10Z",
"updated_at": "2025-04-27T06:03:10Z",
"name": "Rocket Rides",
"metadata": {},
"status": "enabled",
"type": "carrier_managed",
"auth_token": "qzNTrQRQfAnO65UjS6uCYfv6NEbr9ZxvkKK54KdY3iw",
"default_tts_voice": "Basic.Kal"
}
}
}
Update an account
Request
curl "https://api.somleng.org/carrier/v1/accounts/276c522b-5eeb-4fb7-9d4f-07c281f6dcc7" -d '{
"data": {
"attributes": {
"status": null,
"name": "Bob Cats",
"status": "disabled",
"default_tts_voice": "Basic.Kal",
"metadata": {
"bar": "foo"
}
},
"type": "account",
"id": "276c522b-5eeb-4fb7-9d4f-07c281f6dcc7"
}
}' -X PATCH \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer n1m66aN2lpi-3bXkGQiqeiupmnEHwgPtVfmLPxamZN4"
Endpoint
PATCH https://api.somleng.org/carrier/v1/accounts/:id
PATCH https://api.somleng.org/carrier/v1/accounts/276c522b-5eeb-4fb7-9d4f-07c281f6dcc7
Parameters
{
"data": {
"attributes": {
"status": null,
"name": "Bob Cats",
"status": "disabled",
"default_tts_voice": "Basic.Kal",
"metadata": {
"bar": "foo"
}
},
"type": "account",
"id": "276c522b-5eeb-4fb7-9d4f-07c281f6dcc7"
}
}
| Name | Description |
|---|---|
| data[attributes][status] | Update the status of the account. One of either enabled or disabled. |
Response
200 OK
{
"data": {
"id": "276c522b-5eeb-4fb7-9d4f-07c281f6dcc7",
"type": "account",
"attributes": {
"created_at": "2025-04-27T06:03:10Z",
"updated_at": "2025-04-27T06:03:10Z",
"name": "Bob Cats",
"metadata": {
"foo": "bar",
"bar": "foo"
},
"status": "disabled",
"type": "carrier_managed",
"auth_token": "WC7PIk43wyu7a1d3v9tF1eLKUVmKUPe28eVU8PVMxCA",
"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 Hnpd_0ghbCpUVTrhwU5lcNu9uyd9jxwEGxCo6l1F-dg"
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": "784b0abb-95b2-40ff-9529-f374ca3bad98",
"type": "event",
"attributes": {
"created_at": "2025-04-27T06:03:18Z",
"updated_at": "2025-04-27T06:03:18Z",
"type": "phone_call.completed",
"details": {
"data": {
"id": "8da7b067-e2d4-4bb7-8efa-14cb6db31cd0",
"type": "phone_call",
"attributes": {
"to": "+85512334667",
"from": "2442",
"price": null,
"status": "queued",
"duration": null,
"direction": "outbound-api",
"created_at": "2025-04-27T06:03:18Z",
"price_unit": null,
"updated_at": "2025-04-27T06:03:18Z"
},
"relationships": {
"account": {
"data": {
"id": "20e715ae-8c0d-4481-99ca-c495ecbb6ab7",
"type": "account"
}
}
}
}
}
}
}
],
"links": {
"prev": "https://api.somleng.org/carrier/v1/events?page%5Bbefore%5D=784b0abb-95b2-40ff-9529-f374ca3bad98",
"next": null
}
}
Retrieve an Event
Request
curl "https://api.somleng.org/carrier/v1/events/39c27dba-1136-45ed-b4a4-8eb10929b0c4" \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer jiHf6gnQ5SP2MnN41hUh1SKfv845UdpYaQOuUvmik3Q"
Endpoint
GET https://api.somleng.org/carrier/v1/events/:id
GET https://api.somleng.org/carrier/v1/events/39c27dba-1136-45ed-b4a4-8eb10929b0c4
Parameters
None known.
Response
200 OK
{
"data": {
"id": "39c27dba-1136-45ed-b4a4-8eb10929b0c4",
"type": "event",
"attributes": {
"created_at": "2025-04-27T06:03:18Z",
"updated_at": "2025-04-27T06:03:18Z",
"type": "phone_call.completed",
"details": {
"data": {
"id": "bf2c4b31-fea8-4b6b-8c45-283c409265e6",
"type": "phone_call",
"attributes": {
"to": "+85512334667",
"from": "2442",
"price": null,
"status": "queued",
"duration": null,
"direction": "outbound-api",
"created_at": "2025-04-27T06:03:18Z",
"price_unit": null,
"updated_at": "2025-04-27T06:03:18Z"
},
"relationships": {
"account": {
"data": {
"id": "e9641ab4-10bc-4e74-9cb7-f20048ddcf6f",
"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]=940f990d-4b66-408f-8ce5-aba8f85ea5bc&filter[direction]=outbound-api" \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer FyNYfpVPBGSE7d9CbgaZn7ePI7MFPEl3_-vQw3Mi-WE"
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]=940f990d-4b66-408f-8ce5-aba8f85ea5bc&filter[direction]=outbound-api
Parameters
{
"filter": {
"status": "sent",
"from_date": "2021-11-01T00:00:00Z",
"to_date": "2021-11-01T00:00:00Z",
"account": "940f990d-4b66-408f-8ce5-aba8f85ea5bc",
"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": "93afed23-41f5-4c6d-82d6-90f9380e90f0",
"type": "message",
"attributes": {
"created_at": "2021-11-01T01:00:00Z",
"updated_at": "2025-04-27T06:02:40Z",
"to": "+85512334667",
"from": "2442",
"price": null,
"price_unit": null,
"direction": "outbound-api",
"status": "sent",
"body": "Hello World"
},
"relationships": {
"account": {
"data": {
"id": "940f990d-4b66-408f-8ce5-aba8f85ea5bc",
"type": "account"
}
}
}
}
],
"links": {
"prev": "https://api.somleng.org/carrier/v1/messages?filter%5Baccount%5D=940f990d-4b66-408f-8ce5-aba8f85ea5bc&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=93afed23-41f5-4c6d-82d6-90f9380e90f0",
"next": null
}
}
Retrieve a message
Request
curl "https://api.somleng.org/carrier/v1/messages/ecaea71c-8179-4e95-86fc-994ae250bde9" \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer Hs5xBHmUhhB4rX6yxKrOWLOU8wGujVS5oD5rPgUKFUU"
Endpoint
GET https://api.somleng.org/carrier/v1/messages/:id
GET https://api.somleng.org/carrier/v1/messages/ecaea71c-8179-4e95-86fc-994ae250bde9
Parameters
None known.
Response
200 OK
{
"data": {
"id": "ecaea71c-8179-4e95-86fc-994ae250bde9",
"type": "message",
"attributes": {
"created_at": "2025-04-27T06:02:40Z",
"updated_at": "2025-04-27T06:02:40Z",
"to": "+85512334667",
"from": "2442",
"price": null,
"price_unit": null,
"direction": "outbound-api",
"status": "accepted",
"body": "Hello World"
},
"relationships": {
"account": {
"data": {
"id": "9cbae3da-75bc-47d9-abf2-4371e2d2e583",
"type": "account"
}
}
}
}
}
Update a message
Request
curl "https://api.somleng.org/carrier/v1/messages/c355a1a6-5314-40ba-b113-54a4a35fe48a" -d '{
"data": {
"id": "c355a1a6-5314-40ba-b113-54a4a35fe48a",
"type": "message",
"attributes": {
"price": "-0.05"
}
}
}' -X PATCH \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer v19fhYuElIkOOIsIIGdV9p7GIBNQv1aC2x-KLzlAiFc"
Endpoint
PATCH https://api.somleng.org/carrier/v1/messages/:id
PATCH https://api.somleng.org/carrier/v1/messages/c355a1a6-5314-40ba-b113-54a4a35fe48a
Parameters
{
"data": {
"id": "c355a1a6-5314-40ba-b113-54a4a35fe48a",
"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": "c355a1a6-5314-40ba-b113-54a4a35fe48a",
"type": "message",
"attributes": {
"created_at": "2025-04-27T06:02:40Z",
"updated_at": "2025-04-27T06:02:40Z",
"to": "+85512334667",
"from": "2442",
"price": "-0.05",
"price_unit": "USD",
"direction": "outbound-api",
"status": "sent",
"body": "Hello World"
},
"relationships": {
"account": {
"data": {
"id": "538b336a-a7aa-4c63-bd51-4c2a58fd3437",
"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]=84147a1e-9a36-4997-9c3d-a6cd87ea2834&filter[direction]=outbound-api" \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer ds6Dv53Ye5WnvQsjuDxXhpvf21ynWZcqFqh-BCAf_s0"
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]=84147a1e-9a36-4997-9c3d-a6cd87ea2834&filter[direction]=outbound-api
Parameters
{
"filter": {
"status": "queued",
"from_date": "2021-11-01T00:00:00Z",
"to_date": "2021-11-01T00:00:00Z",
"account": "84147a1e-9a36-4997-9c3d-a6cd87ea2834",
"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": "88cc5bf7-a2a8-4a2d-9c3a-a87841a2e84a",
"type": "phone_call",
"attributes": {
"created_at": "2021-11-01T01:00:00Z",
"updated_at": "2025-04-27T06:02:32Z",
"to": "+85512334667",
"from": "2442",
"price": null,
"price_unit": null,
"duration": null,
"direction": "outbound-api",
"status": "queued"
},
"relationships": {
"account": {
"data": {
"id": "84147a1e-9a36-4997-9c3d-a6cd87ea2834",
"type": "account"
}
}
}
}
],
"links": {
"prev": "https://api.somleng.org/carrier/v1/phone_calls?filter%5Baccount%5D=84147a1e-9a36-4997-9c3d-a6cd87ea2834&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=88cc5bf7-a2a8-4a2d-9c3a-a87841a2e84a",
"next": null
}
}
Retrieve a phone call
Request
curl "https://api.somleng.org/carrier/v1/phone_calls/fd03fa94-608d-49fe-a4aa-c9e924e5c3dd" \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer zJrA3BToarPtCRwfgpoyM7hMIsKLsvtPTwx-Mo5iRDw"
Endpoint
GET https://api.somleng.org/carrier/v1/phone_calls/:id
GET https://api.somleng.org/carrier/v1/phone_calls/fd03fa94-608d-49fe-a4aa-c9e924e5c3dd
Parameters
None known.
Response
200 OK
{
"data": {
"id": "fd03fa94-608d-49fe-a4aa-c9e924e5c3dd",
"type": "phone_call",
"attributes": {
"created_at": "2025-04-27T06:02:32Z",
"updated_at": "2025-04-27T06:02:32Z",
"to": "+85512334667",
"from": "2442",
"price": null,
"price_unit": null,
"duration": null,
"direction": "outbound-api",
"status": "queued"
},
"relationships": {
"account": {
"data": {
"id": "fd61edd9-9361-4b68-be83-2d50ffd3506a",
"type": "account"
}
}
}
}
}
Update a phone call
Request
curl "https://api.somleng.org/carrier/v1/phone_calls/975d68f3-b9e1-4b1d-a4eb-15236c981ec0" -d '{
"data": {
"id": "975d68f3-b9e1-4b1d-a4eb-15236c981ec0",
"type": "phone_call",
"attributes": {
"price": "-0.05"
}
}
}' -X PATCH \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer v6vNa36m05Cd6xEVMQvpbwM8ARnBqR7MFzM5A12V3cs"
Endpoint
PATCH https://api.somleng.org/carrier/v1/phone_calls/:id
PATCH https://api.somleng.org/carrier/v1/phone_calls/975d68f3-b9e1-4b1d-a4eb-15236c981ec0
Parameters
{
"data": {
"id": "975d68f3-b9e1-4b1d-a4eb-15236c981ec0",
"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": "975d68f3-b9e1-4b1d-a4eb-15236c981ec0",
"type": "phone_call",
"attributes": {
"created_at": "2025-04-27T06:02:32Z",
"updated_at": "2025-04-27T06:02:32Z",
"to": "+85512334667",
"from": "2442",
"price": "-0.05",
"price_unit": "USD",
"duration": "5",
"direction": "outbound-api",
"status": "completed"
},
"relationships": {
"account": {
"data": {
"id": "5a73c09b-aa86-40a6-b658-854d921f683e",
"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 HIe9TVR68H9BnPC_uLdP5knBjzylss9ekevfIs7VtD4"
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": "aafaf674-5a9d-4367-a2f0-be67b47da62d",
"type": "phone_number",
"attributes": {
"created_at": "2025-04-27T06:03:09Z",
"updated_at": "2025-04-27T06:03:09Z",
"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/4bcdd322-a3b9-4ba5-8121-98f234fe3cbf" -d '{
"data": {
"type": "phone_number",
"id": "4bcdd322-a3b9-4ba5-8121-98f234fe3cbf",
"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 sIesdROwQ52_fTy5Lu90m4ZmL_qQSaijGedR3wL1g6Y"
Endpoint
PATCH https://api.somleng.org/carrier/v1/phone_numbers/:id
PATCH https://api.somleng.org/carrier/v1/phone_numbers/4bcdd322-a3b9-4ba5-8121-98f234fe3cbf
Parameters
{
"data": {
"type": "phone_number",
"id": "4bcdd322-a3b9-4ba5-8121-98f234fe3cbf",
"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": "4bcdd322-a3b9-4ba5-8121-98f234fe3cbf",
"type": "phone_number",
"attributes": {
"created_at": "2025-04-27T06:03:09Z",
"updated_at": "2025-04-27T06:03:09Z",
"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/367dbb1f-d0d3-42a4-bc69-d1174ee4d8b9" \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer RluXkBTR6960yzwY8upd8dzV2ppGr9S1J59yeZH3iUg"
Endpoint
GET https://api.somleng.org/carrier/v1/phone_numbers/:id
GET https://api.somleng.org/carrier/v1/phone_numbers/367dbb1f-d0d3-42a4-bc69-d1174ee4d8b9
Parameters
None known.
Response
200 OK
{
"data": {
"id": "367dbb1f-d0d3-42a4-bc69-d1174ee4d8b9",
"type": "phone_number",
"attributes": {
"created_at": "2025-04-27T06:03:09Z",
"updated_at": "2025-04-27T06:03:09Z",
"number": "+855972345834",
"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 fT8PmRdGFVI-TifkGmC97cskzh6iILlpeCwDaVXO0_4"
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": "ad90ab73-a56f-416c-83dc-38f36d3d005d",
"type": "phone_number",
"attributes": {
"created_at": "2025-04-27T06:03:09Z",
"updated_at": "2025-04-27T06:03:09Z",
"number": "+855972345832",
"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": "dd8289f2-38c5-41c9-aeea-786a60e53d54",
"type": "phone_number",
"attributes": {
"created_at": "2025-04-27T06:03:09Z",
"updated_at": "2025-04-27T06:03:09Z",
"number": "+855972345831",
"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=ad90ab73-a56f-416c-83dc-38f36d3d005d",
"next": null
}
}
05. Delete a phone number
Request
curl "https://api.somleng.org/carrier/v1/phone_numbers/9e94d829-cfeb-47fc-9c4e-41e34d44ce14" -d '' -X DELETE \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer a8ndmI3NewTpkpQjHdU0FdLR4Xx_40BDrGForj0VqGQ"
Endpoint
DELETE https://api.somleng.org/carrier/v1/phone_numbers/:id
DELETE https://api.somleng.org/carrier/v1/phone_numbers/9e94d829-cfeb-47fc-9c4e-41e34d44ce14
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 q0mMkJR-bKjoW3_53E4TISstPVVm9S78PPOxyv9DZOk"
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]=2025-04-26&filter[account]=e73a9aa7-43fc-4d61-b107-c1338871d5ed&filter[phone_call]=804327d7-5109-4a09-aec7-c7c1bd2b6dcc" \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer EBwyAbXmIpUh9NGsvJGWwJv8KXCcpyzQoe9Fll3FAe4"
Endpoint
GET https://api.somleng.org/carrier/v1/tts_events
GET https://api.somleng.org/carrier/v1/tts_events?filter[from_date]=2025-04-26&filter[account]=e73a9aa7-43fc-4d61-b107-c1338871d5ed&filter[phone_call]=804327d7-5109-4a09-aec7-c7c1bd2b6dcc
Parameters
{
"filter": {
"from_date": "2025-04-26",
"account": "e73a9aa7-43fc-4d61-b107-c1338871d5ed",
"phone_call": "804327d7-5109-4a09-aec7-c7c1bd2b6dcc"
}
}
| 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": "974924e9-ab36-4f6f-a9e7-267b8edfd13f",
"type": "tts_event",
"attributes": {
"created_at": "2025-04-27T06:03:25Z",
"updated_at": "2025-04-27T06:03:25Z",
"voice": "Basic.Kal (Male, en-US)",
"characters": 200
},
"relationships": {
"account": {
"data": {
"id": "e73a9aa7-43fc-4d61-b107-c1338871d5ed",
"type": "account"
}
},
"phone_call": {
"data": {
"id": "804327d7-5109-4a09-aec7-c7c1bd2b6dcc",
"type": "phone_call"
}
}
}
},
{
"id": "f79122ae-7609-4cea-a224-1712ba0e3e32",
"type": "tts_event",
"attributes": {
"created_at": "2025-04-27T06:03:25Z",
"updated_at": "2025-04-27T06:03:25Z",
"voice": "Basic.Kal (Male, en-US)",
"characters": 100
},
"relationships": {
"account": {
"data": {
"id": "e73a9aa7-43fc-4d61-b107-c1338871d5ed",
"type": "account"
}
},
"phone_call": {
"data": {
"id": "804327d7-5109-4a09-aec7-c7c1bd2b6dcc",
"type": "phone_call"
}
}
}
}
],
"links": {
"prev": "https://api.somleng.org/carrier/v1/tts_events?filter%5Baccount%5D=e73a9aa7-43fc-4d61-b107-c1338871d5ed&filter%5Bfrom_date%5D=2025-04-26&filter%5Bphone_call%5D=804327d7-5109-4a09-aec7-c7c1bd2b6dcc&page%5Bbefore%5D=974924e9-ab36-4f6f-a9e7-267b8edfd13f",
"next": null
}
}
Retrieve a TTS Event
Request
curl "https://api.somleng.org/carrier/v1/tts_events/ac46d577-022e-463d-9a30-1de4847bae88" \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer HoYvvBgjx6P-uSHSwR2bH3iucVij3-iwYpkLFbQLwOg"
Endpoint
GET https://api.somleng.org/carrier/v1/tts_events/:id
GET https://api.somleng.org/carrier/v1/tts_events/ac46d577-022e-463d-9a30-1de4847bae88
Parameters
None known.
Response
200 OK
{
"data": {
"id": "ac46d577-022e-463d-9a30-1de4847bae88",
"type": "tts_event",
"attributes": {
"created_at": "2025-04-27T06:03:25Z",
"updated_at": "2025-04-27T06:03:25Z",
"voice": "Basic.Kal (Male, en-US)",
"characters": 100
},
"relationships": {
"account": {
"data": {
"id": "4dfb9166-bd22-4ed7-84f4-579072dc1b48",
"type": "account"
}
},
"phone_call": {
"data": {
"id": "11c3b864-5466-47ea-b707-bfd5dac29100",
"type": "phone_call"
}
}
}
}
}