API endpoints for managing dedicated numbers as sender IDs for messaging services.
API endpoints for managing dedicated numbers as sender IDs for messaging services.
Get all available dedicated numbers
Parameter | In | Type | Required | Description |
---|---|---|---|---|
page | query | integer(int32) | false | Page number |
limit | query | integer(int32) | false | Number of records per page |
q | query | string | false | Filter numbers based on multiple criteria. The query string should be formatted as key-value pairs separated by commas. Available filter keys: type , number_type , country |
q2 | query | string | false | Filter numbers based on multiple criteria. The query string should be formatted as key-value pairs separated by commas. Available filter keys: type |
excluding_number_type | query | string | false | Exclude specific number types from the results. Available number types: shortcode , tollfree , 10DLC |
exclude_10dlc_campaign | query | boolean | false | When set to true, excludes all numbers that are associated with 10DLC campaigns |
Refer to Status Codes for definitions of HTTP status code responses.
Filter numbers based on multiple criteria. The query string should be formatted as key-value pairs separated by commas. Available filter keys:
type
: Message type (e.g., SMS
, MMS
)number_type
: Number classification (e.g., longcode
, shortcode
, tollfree
, 10DLC
)country
: Two-letter country code (e.g., AU
, US
)Exclude specific number types from the results. Available number types:
shortcode
tollfree
10DLC
curl --include \
--header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA==" \
'https://rest.clicksend.com/v3/numbers'
{ "http_code": 200, "response_code": "SUCCESS", "response_msg": "Here are you dedicated numbers.", "data": { "total": 2, "per_page": 15, "current_page": 1, "last_page": 1, "next_page_url": null, "prev_page_url": null, "from": 1, "to": 2, "data": [ … ] } }
Buy dedicated number
Parameter | In | Type | Required | Description |
---|---|---|---|---|
dedicated_number | path | string | true | Phone number to purchase |
Refer to Status Codes for definitions of HTTP status code responses.
curl --include \
--header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA==" \
--request POST \
'https://rest.clicksend.com/v3/numbers/buy/{dedicated_number}'
{ "http_code": 200, "response_code": "SUCCESS", "response_msg": "Here is your new number.", "data": { "dedicated_number": "+12282060576", "country": "US", "price_total": "8.98", "_price_setup": "22.22", "_price_monthly": "11.11", "_currency": { … } } }
Get all dedicated numbers by country
Parameter | In | Type | Required | Description |
---|---|---|---|---|
country | path | string | true | Country code to search |
search | query | string | false | Your search pattern or query. |
search_type | query | integer(int32) | false | Your strategy for searching, 0 = starts with, 1 = anywhere, 2 = ends with. |
page | query | integer(int32) | false | Page number |
limit | query | integer(int32) | false | Number of records per page |
Refer to Status Codes for definitions of HTTP status code responses.
curl --include \
--header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA==" \
'https://rest.clicksend.com/v3/numbers/search/{country}'
Successful response
A message describing the outcome of the operation.
{ "http_code": 200, "response_code": "SUCCESS", "response_msg": "Here are some numbers.", "data": [ { … }, { … } ], "_currency": { "currency_name_short": "AUD", "currency_prefix_d": "$", "currency_prefix_c": "c", "currency_name_long": "Australian Dollars" } }
Registers a number that requires additional verification information. This endpoint facilitates the registration process for numbers requiring special compliance documentation.
After submission, ClickSend's compliance team will review the registration and notify you of the approval status.
Refer to Status Codes for definitions of HTTP status code responses.
Legal full name of the individual registering the number. Must be a personal name, not a business name.
Legal business name of the organization requesting registration
Contact email address for registration communications and notifications
Representative example of messages that will be sent using this number
Primary intended purpose for the registered number (e.g., Marketing, Notifications, Authentication)
Official support phone number of the organization requesting registration
curl --include \
--header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA==" \
--request POST \
--header "Content-Type: application/json" \
--data-binary " {
\"full_name\": \"John Doe\",
\"company_name\": \"Clicksend\",
\"email\": \"john.doe@clicksend.com\",
\"website_url\": \"https://clicksend.com\",
\"sample_message\": \"Get 20% off on your next purchase! Visit our website for details.\",
\"primary_use_case\": \"Marketing\"
}" \
'https://rest.clicksend.com/v3/numbers/registrations/number-types/{number_type}/country/{country_code}'
{ "http_code": 200, "response_code": "SUCCESS", "response_msg": "Number registration notification sent successfully.", "data": null }