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 eA6AIBKACbVIvez9eQ-mv8CDGcoZILzkETMjEN_8Yww"
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": "0ea4a2ec-203c-4722-86cd-8d5ab5835f4e",
"type": "account",
"attributes": {
"created_at": "2024-10-31T13:59:16Z",
"updated_at": "2024-10-31T13:59:16Z",
"name": "Rocket Rides",
"metadata": {
"foo": "bar"
},
"status": "enabled",
"type": "carrier_managed",
"auth_token": "zGKsChyORTTjhrufsb4psIqiMHRQXKtwe0hpdKtM8fg",
"default_tts_voice": "Basic.Kal"
}
}
}
Delete an account
Request
curl "https://api.somleng.org/carrier/v1/accounts/1b811ac9-6b05-4b5e-9cc2-c7e5a8a5a1e1" -d '' -X DELETE \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer lZdnOZH81yZFDQJmrwiaevEm_mFNxYKZhmQxr3VSSgg"
Endpoint
DELETE https://api.somleng.org/carrier/v1/accounts/:id
DELETE https://api.somleng.org/carrier/v1/accounts/1b811ac9-6b05-4b5e-9cc2-c7e5a8a5a1e1
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 mrMeS1rIPp_RxjjYqf3FpipZBFoZX-w3qOuHCXPb8yk"
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": "1bf6fb78-6469-4d4e-b0f6-5aff1b604097",
"type": "account",
"attributes": {
"created_at": "2024-10-31T13:59:16Z",
"updated_at": "2024-10-31T13:59:16Z",
"name": "Telco Net",
"metadata": {
},
"status": "enabled",
"type": "carrier_managed",
"auth_token": "9gzkPIc0IbSCzzmMPg2BWUU3cjdXMedhKtu4OYDYgjc",
"default_tts_voice": "Basic.Kal"
}
},
{
"id": "ebebd498-9885-4381-a0ce-6d37305227ea",
"type": "account",
"attributes": {
"created_at": "2024-10-31T13:59:16Z",
"updated_at": "2024-10-31T13:59:16Z",
"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=1bf6fb78-6469-4d4e-b0f6-5aff1b604097",
"next": null
}
}
Retrieve an account
Request
curl "https://api.somleng.org/carrier/v1/accounts/fa19f038-f58d-46f4-bf08-9e92f77eee0d" \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer pcTM8DS_M4ELuNlgv27shrnCsvglxQldLtgsDYBi6wQ"
Endpoint
GET https://api.somleng.org/carrier/v1/accounts/:id
GET https://api.somleng.org/carrier/v1/accounts/fa19f038-f58d-46f4-bf08-9e92f77eee0d
Parameters
| Name | Description |
|---|---|
| id required | The id of the account to be retrieved. |
Response
200 OK
{
"data": {
"id": "fa19f038-f58d-46f4-bf08-9e92f77eee0d",
"type": "account",
"attributes": {
"created_at": "2024-10-31T13:59:16Z",
"updated_at": "2024-10-31T13:59:16Z",
"name": "Rocket Rides",
"metadata": {
},
"status": "enabled",
"type": "carrier_managed",
"auth_token": "ExvCdaIlFfGdcKHsm40RR8IyyoqNA-K8D6Ebzw8JOfU",
"default_tts_voice": "Basic.Kal"
}
}
}
Update an account
Request
curl "https://api.somleng.org/carrier/v1/accounts/2f206557-76d1-4c95-9a0d-ed50a334b4ed" -d '{
"data": {
"attributes": {
"status": null,
"name": "Bob Cats",
"status": "disabled",
"default_tts_voice": "Basic.Kal",
"metadata": {
"bar": "foo"
}
},
"type": "account",
"id": "2f206557-76d1-4c95-9a0d-ed50a334b4ed"
}
}' -X PATCH \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer uCHd98YPnXR72y6KIaavxuVtt7Pi3VjwXxLbT_BHWxI"
Endpoint
PATCH https://api.somleng.org/carrier/v1/accounts/:id
PATCH https://api.somleng.org/carrier/v1/accounts/2f206557-76d1-4c95-9a0d-ed50a334b4ed
Parameters
{
"data": {
"attributes": {
"status": null,
"name": "Bob Cats",
"status": "disabled",
"default_tts_voice": "Basic.Kal",
"metadata": {
"bar": "foo"
}
},
"type": "account",
"id": "2f206557-76d1-4c95-9a0d-ed50a334b4ed"
}
}
| Name | Description |
|---|---|
| data[attributes][status] | Update the status of the account. One of either enabled or disabled. |
Response
200 OK
{
"data": {
"id": "2f206557-76d1-4c95-9a0d-ed50a334b4ed",
"type": "account",
"attributes": {
"created_at": "2024-10-31T13:59:16Z",
"updated_at": "2024-10-31T13:59:16Z",
"name": "Bob Cats",
"metadata": {
"foo": "bar",
"bar": "foo"
},
"status": "disabled",
"type": "carrier_managed",
"auth_token": "Xj0eOuts9JqCW-qoySOiLBh_FEgxTi3i9qBi5U9mdps",
"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 mfqXxu9rHLjFIlgYorF3h16MukS920XRTd68MRiYdFg"
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": "f6189f56-fe5e-43c6-af41-bde37619a130",
"type": "event",
"attributes": {
"created_at": "2024-10-31T13:58:54Z",
"updated_at": "2024-10-31T13:58:54Z",
"type": "phone_call.completed",
"details": {
"data": {
"id": "df78d11d-492f-4da0-acd0-06982ea9e844",
"type": "phone_call",
"attributes": {
"to": "+85512334667",
"from": "2442",
"price": null,
"status": "queued",
"duration": null,
"direction": "outbound-api",
"created_at": "2024-10-31T13:58:54Z",
"price_unit": null,
"updated_at": "2024-10-31T13:58:54Z"
},
"relationships": {
"account": {
"data": {
"id": "37182d0d-3eb8-4e36-bfd2-089031b0b943",
"type": "account"
}
}
}
}
}
}
}
],
"links": {
"prev": "https://api.somleng.org/carrier/v1/events?page%5Bbefore%5D=f6189f56-fe5e-43c6-af41-bde37619a130",
"next": null
}
}
Retrieve an Event
Request
curl "https://api.somleng.org/carrier/v1/events/b1fb873b-be22-4308-a1a6-92cde6a5c97e" \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer 0bOLLBlpjcfqeKeE6RBgeRFAiATHSLP7HBpwW7k45VU"
Endpoint
GET https://api.somleng.org/carrier/v1/events/:id
GET https://api.somleng.org/carrier/v1/events/b1fb873b-be22-4308-a1a6-92cde6a5c97e
Parameters
None known.
Response
200 OK
{
"data": {
"id": "b1fb873b-be22-4308-a1a6-92cde6a5c97e",
"type": "event",
"attributes": {
"created_at": "2024-10-31T13:58:54Z",
"updated_at": "2024-10-31T13:58:54Z",
"type": "phone_call.completed",
"details": {
"data": {
"id": "74583f29-2082-48ae-9d3f-73d71805b412",
"type": "phone_call",
"attributes": {
"to": "+85512334667",
"from": "2442",
"price": null,
"status": "queued",
"duration": null,
"direction": "outbound-api",
"created_at": "2024-10-31T13:58:54Z",
"price_unit": null,
"updated_at": "2024-10-31T13:58:54Z"
},
"relationships": {
"account": {
"data": {
"id": "ebedb140-553d-47bd-bcb9-adaeff2a7221",
"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]=e2e0c91b-c158-4b90-a7c7-610972ffb675&filter[direction]=outbound-api" \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer 2uSYA0BNekzEreCaCeRCNDnewvGAGXAu6UPeFOg9Ho0"
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]=e2e0c91b-c158-4b90-a7c7-610972ffb675&filter[direction]=outbound-api
Parameters
{
"filter": {
"status": "sent",
"from_date": "2021-11-01T00:00:00Z",
"to_date": "2021-11-01T00:00:00Z",
"account": "e2e0c91b-c158-4b90-a7c7-610972ffb675",
"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": "e4dd5562-7c38-4115-8bc7-e040a9d4cf68",
"type": "message",
"attributes": {
"created_at": "2021-11-01T01:00:00Z",
"updated_at": "2024-10-31T13:59:48Z",
"to": "+85512334667",
"from": "2442",
"price": null,
"price_unit": null,
"direction": "outbound-api",
"status": "sent",
"body": "Hello World"
},
"relationships": {
"account": {
"data": {
"id": "e2e0c91b-c158-4b90-a7c7-610972ffb675",
"type": "account"
}
}
}
}
],
"links": {
"prev": "https://api.somleng.org/carrier/v1/messages?filter%5Baccount%5D=e2e0c91b-c158-4b90-a7c7-610972ffb675&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=e4dd5562-7c38-4115-8bc7-e040a9d4cf68",
"next": null
}
}
Retrieve a message
Request
curl "https://api.somleng.org/carrier/v1/messages/7cf63565-523e-42e6-8d81-2eb93cc723fd" \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer SXa8iqdbtoWE-Adby4Z_HgnZODUrRYT8M2-DKVKxK5g"
Endpoint
GET https://api.somleng.org/carrier/v1/messages/:id
GET https://api.somleng.org/carrier/v1/messages/7cf63565-523e-42e6-8d81-2eb93cc723fd
Parameters
None known.
Response
200 OK
{
"data": {
"id": "7cf63565-523e-42e6-8d81-2eb93cc723fd",
"type": "message",
"attributes": {
"created_at": "2024-10-31T13:59:48Z",
"updated_at": "2024-10-31T13:59:48Z",
"to": "+85512334667",
"from": "2442",
"price": null,
"price_unit": null,
"direction": "outbound-api",
"status": "accepted",
"body": "Hello World"
},
"relationships": {
"account": {
"data": {
"id": "9f5eca89-8b9f-4320-9822-023710f89db9",
"type": "account"
}
}
}
}
}
Update a message
Request
curl "https://api.somleng.org/carrier/v1/messages/475286ee-337b-46fc-958c-6cd0e525276b" -d '{
"data": {
"id": "475286ee-337b-46fc-958c-6cd0e525276b",
"type": "message",
"attributes": {
"price": "-0.05"
}
}
}' -X PATCH \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer 6qhPGAydaxlKNp5hwxjg-6oIwkzlWuDG81DPQd6I4F4"
Endpoint
PATCH https://api.somleng.org/carrier/v1/messages/:id
PATCH https://api.somleng.org/carrier/v1/messages/475286ee-337b-46fc-958c-6cd0e525276b
Parameters
{
"data": {
"id": "475286ee-337b-46fc-958c-6cd0e525276b",
"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": "475286ee-337b-46fc-958c-6cd0e525276b",
"type": "message",
"attributes": {
"created_at": "2024-10-31T13:59:48Z",
"updated_at": "2024-10-31T13:59:48Z",
"to": "+85512334667",
"from": "2442",
"price": "-0.05",
"price_unit": "USD",
"direction": "outbound-api",
"status": "sent",
"body": "Hello World"
},
"relationships": {
"account": {
"data": {
"id": "5d50a4c1-1153-4053-a27e-4837e31b206b",
"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]=3109c7a1-6d20-4aa0-9a84-868aa8106faf&filter[direction]=outbound-api" \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer wXIryqySs-qtn5oD34R53FzCCdGEgp3Fsn8DJcenqfY"
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]=3109c7a1-6d20-4aa0-9a84-868aa8106faf&filter[direction]=outbound-api
Parameters
{
"filter": {
"status": "queued",
"from_date": "2021-11-01T00:00:00Z",
"to_date": "2021-11-01T00:00:00Z",
"account": "3109c7a1-6d20-4aa0-9a84-868aa8106faf",
"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": "fb342b0e-26d2-4c4f-a7b2-3b96f2fc4ac6",
"type": "phone_call",
"attributes": {
"created_at": "2021-11-01T01:00:00Z",
"updated_at": "2024-10-31T13:59:18Z",
"to": "+85512334667",
"from": "2442",
"price": null,
"price_unit": null,
"duration": null,
"direction": "outbound-api",
"status": "queued"
},
"relationships": {
"account": {
"data": {
"id": "3109c7a1-6d20-4aa0-9a84-868aa8106faf",
"type": "account"
}
}
}
}
],
"links": {
"prev": "https://api.somleng.org/carrier/v1/phone_calls?filter%5Baccount%5D=3109c7a1-6d20-4aa0-9a84-868aa8106faf&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=fb342b0e-26d2-4c4f-a7b2-3b96f2fc4ac6",
"next": null
}
}
Retrieve a phone call
Request
curl "https://api.somleng.org/carrier/v1/phone_calls/934e302f-9064-40b6-9069-a1b9b4b02fb5" \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer B7Wvlj17HMy5HL2U0KuEhCnKzJDHygPYktPf9BsLCOc"
Endpoint
GET https://api.somleng.org/carrier/v1/phone_calls/:id
GET https://api.somleng.org/carrier/v1/phone_calls/934e302f-9064-40b6-9069-a1b9b4b02fb5
Parameters
None known.
Response
200 OK
{
"data": {
"id": "934e302f-9064-40b6-9069-a1b9b4b02fb5",
"type": "phone_call",
"attributes": {
"created_at": "2024-10-31T13:59:19Z",
"updated_at": "2024-10-31T13:59:19Z",
"to": "+85512334667",
"from": "2442",
"price": null,
"price_unit": null,
"duration": null,
"direction": "outbound-api",
"status": "queued"
},
"relationships": {
"account": {
"data": {
"id": "6d5b6c5b-370e-4176-814b-b26de6d6f3d2",
"type": "account"
}
}
}
}
}
Update a phone call
Request
curl "https://api.somleng.org/carrier/v1/phone_calls/1911dfee-959a-4b3d-945d-9f32ad04cb73" -d '{
"data": {
"id": "1911dfee-959a-4b3d-945d-9f32ad04cb73",
"type": "phone_call",
"attributes": {
"price": "-0.05"
}
}
}' -X PATCH \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer -iv2H_ctARDXTglf2tCI0XbysiBDtD4dXuFrCeqbIoU"
Endpoint
PATCH https://api.somleng.org/carrier/v1/phone_calls/:id
PATCH https://api.somleng.org/carrier/v1/phone_calls/1911dfee-959a-4b3d-945d-9f32ad04cb73
Parameters
{
"data": {
"id": "1911dfee-959a-4b3d-945d-9f32ad04cb73",
"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": "1911dfee-959a-4b3d-945d-9f32ad04cb73",
"type": "phone_call",
"attributes": {
"created_at": "2024-10-31T13:59:18Z",
"updated_at": "2024-10-31T13:59:18Z",
"to": "+85512334667",
"from": "2442",
"price": "-0.05",
"price_unit": "USD",
"duration": "5",
"direction": "outbound-api",
"status": "completed"
},
"relationships": {
"account": {
"data": {
"id": "e7209b33-d2ee-4c28-a7a4-7ff6cb181205",
"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 G5ykM7uGL8fZDZhS30H2kCjb1snp_mGTIxdxxA83nD0"
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": "d58c3932-f86e-4dd4-9245-2e309261027d",
"type": "phone_number",
"attributes": {
"created_at": "2024-10-31T13:59:26Z",
"updated_at": "2024-10-31T13:59:26Z",
"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/0bf077a9-6e55-469e-aae7-254cd4216a02" -d '{
"data": {
"type": "phone_number",
"id": "0bf077a9-6e55-469e-aae7-254cd4216a02",
"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 jhlj4WcvFHoUUenUb9150h81fApXo1VwJr1pIoCEdD4"
Endpoint
PATCH https://api.somleng.org/carrier/v1/phone_numbers/:id
PATCH https://api.somleng.org/carrier/v1/phone_numbers/0bf077a9-6e55-469e-aae7-254cd4216a02
Parameters
{
"data": {
"type": "phone_number",
"id": "0bf077a9-6e55-469e-aae7-254cd4216a02",
"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": "0bf077a9-6e55-469e-aae7-254cd4216a02",
"type": "phone_number",
"attributes": {
"created_at": "2024-10-31T13:59:26Z",
"updated_at": "2024-10-31T13:59:26Z",
"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/f3ac9553-a14b-4742-b581-bb9c42889408" \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer y9ivBKpGK8D2GuZm3mZQKW86z_y-L0ugts-UkXBaY0k"
Endpoint
GET https://api.somleng.org/carrier/v1/phone_numbers/:id
GET https://api.somleng.org/carrier/v1/phone_numbers/f3ac9553-a14b-4742-b581-bb9c42889408
Parameters
None known.
Response
200 OK
{
"data": {
"id": "f3ac9553-a14b-4742-b581-bb9c42889408",
"type": "phone_number",
"attributes": {
"created_at": "2024-10-31T13:59:26Z",
"updated_at": "2024-10-31T13:59:26Z",
"number": "+855972345766",
"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 te3MZjHO2GUAS3GHTkiV_yIc3ZMBqvrjsfLDG2QQgqc"
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": "177361d0-5148-4237-a718-bd61bb335ab7",
"type": "phone_number",
"attributes": {
"created_at": "2024-10-31T13:59:27Z",
"updated_at": "2024-10-31T13:59:27Z",
"number": "+855972345768",
"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": "7b3e9218-b99f-4ed9-8541-0e18b51b59ed",
"type": "phone_number",
"attributes": {
"created_at": "2024-10-31T13:59:27Z",
"updated_at": "2024-10-31T13:59:27Z",
"number": "+855972345767",
"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=177361d0-5148-4237-a718-bd61bb335ab7",
"next": null
}
}
05. Delete a phone number
Request
curl "https://api.somleng.org/carrier/v1/phone_numbers/4ba55b01-5e8a-402a-9b0a-6d2e126c06bd" -d '' -X DELETE \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer hzLhJsMN0pc56ow0i5KNYiOADNOgFd_sT4zBdXQRnlc"
Endpoint
DELETE https://api.somleng.org/carrier/v1/phone_numbers/:id
DELETE https://api.somleng.org/carrier/v1/phone_numbers/4ba55b01-5e8a-402a-9b0a-6d2e126c06bd
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 S6joa78UhROUWHPrR-_JWC7X3Bxy_-9ev1UhTz7wdo0"
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]=2024-10-30&filter[account]=433b8e5e-b5f9-40bb-bc3a-6a953e58767c&filter[phone_call]=1752ab3c-1ad3-43f3-bc8c-8ad04d867b18" \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer Y6yxbInOTlf__lQi2aOuUq3tEmOlv6XSJFJHarHN7mE"
Endpoint
GET https://api.somleng.org/carrier/v1/tts_events
GET https://api.somleng.org/carrier/v1/tts_events?filter[from_date]=2024-10-30&filter[account]=433b8e5e-b5f9-40bb-bc3a-6a953e58767c&filter[phone_call]=1752ab3c-1ad3-43f3-bc8c-8ad04d867b18
Parameters
{
"filter": {
"from_date": "2024-10-30",
"account": "433b8e5e-b5f9-40bb-bc3a-6a953e58767c",
"phone_call": "1752ab3c-1ad3-43f3-bc8c-8ad04d867b18"
}
}
| 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": "e0edbea0-a904-4750-9355-0e839aa32121",
"type": "tts_event",
"attributes": {
"created_at": "2024-10-31T13:59:18Z",
"updated_at": "2024-10-31T13:59:18Z",
"voice": "Basic.Kal (Male, en-US)",
"characters": 200
},
"relationships": {
"account": {
"data": {
"id": "433b8e5e-b5f9-40bb-bc3a-6a953e58767c",
"type": "account"
}
},
"phone_call": {
"data": {
"id": "1752ab3c-1ad3-43f3-bc8c-8ad04d867b18",
"type": "phone_call"
}
}
}
},
{
"id": "a843404f-878e-41e7-a84e-ffd67b95abfd",
"type": "tts_event",
"attributes": {
"created_at": "2024-10-31T13:59:18Z",
"updated_at": "2024-10-31T13:59:18Z",
"voice": "Basic.Kal (Male, en-US)",
"characters": 100
},
"relationships": {
"account": {
"data": {
"id": "433b8e5e-b5f9-40bb-bc3a-6a953e58767c",
"type": "account"
}
},
"phone_call": {
"data": {
"id": "1752ab3c-1ad3-43f3-bc8c-8ad04d867b18",
"type": "phone_call"
}
}
}
}
],
"links": {
"prev": "https://api.somleng.org/carrier/v1/tts_events?filter%5Baccount%5D=433b8e5e-b5f9-40bb-bc3a-6a953e58767c&filter%5Bfrom_date%5D=2024-10-30&filter%5Bphone_call%5D=1752ab3c-1ad3-43f3-bc8c-8ad04d867b18&page%5Bbefore%5D=e0edbea0-a904-4750-9355-0e839aa32121",
"next": null
}
}
Retrieve a TTS Event
Request
curl "https://api.somleng.org/carrier/v1/tts_events/8549b203-5b43-41cf-891e-d533454d9230" \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer Yh3ml6VV9S6DEt_X0x52Hi2EeacKzsSGiIwigqy5aDs"
Endpoint
GET https://api.somleng.org/carrier/v1/tts_events/:id
GET https://api.somleng.org/carrier/v1/tts_events/8549b203-5b43-41cf-891e-d533454d9230
Parameters
None known.
Response
200 OK
{
"data": {
"id": "8549b203-5b43-41cf-891e-d533454d9230",
"type": "tts_event",
"attributes": {
"created_at": "2024-10-31T13:59:18Z",
"updated_at": "2024-10-31T13:59:18Z",
"voice": "Basic.Kal (Male, en-US)",
"characters": 100
},
"relationships": {
"account": {
"data": {
"id": "d54f90ef-ec47-46c8-8a6b-13d20ed079be",
"type": "account"
}
},
"phone_call": {
"data": {
"id": "3a2d0475-30b3-4232-9191-aaed3870851f",
"type": "phone_call"
}
}
}
}
}