Numbers (1.0.0)

API endpoints for managing dedicated numbers as sender IDs for messaging services.

View Your Numbers

Get all available dedicated numbers

Parameters

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.

This endpoint requires authentication, more info...
Request
query Parameters
page
integer >= 1
Default: 1

Page number

Example: page=1
limit
integer >= 15
Default: 15

Number of records per page

Example: limit=100
q
string

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)
Example: q=type:sms,number_type:longcode,country:AU
q2
string
Example: q2=type:mms
excluding_number_type
string

Exclude specific number types from the results. Available number types:

  • shortcode
  • tollfree
  • 10DLC
Example: excluding_number_type=10DLC
exclude_10dlc_campaign
boolean
Default: false

When set to true, excludes all numbers that are associated with 10DLC campaigns

Example: exclude_10dlc_campaign=true
header Parameters
Content-Type
string
Example: application/json
Responses
200

Successful response

get/v3/numbers
Request samples 
curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \

'https://rest.clicksend.com/v3/numbers'
Response samples
application/json
{
  • "http_code": 200,
  • "response_code": "SUCCESS",
  • "response_msg": "Here are you dedicated numbers.",
  • "data": {
    }
}

Purchase Dedicated Number

Buy dedicated number

Parameters

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.

This endpoint requires authentication, more info...
Request
path Parameters
dedicated_number
required
string
query Parameters
type
string
Example: type=sms
header Parameters
Content-Type
string
Example: application/json
Request Body schema: application/json
object
Responses
200

Successful response

post/v3/numbers/buy/{dedicated_number}
Request samples
application/json
""
Response samples
application/json
{
  • "http_code": 200,
  • "response_code": "SUCCESS",
  • "response_msg": "Here is your new number.",
  • "data": {
    }
}

View Available Numbers

Get all dedicated numbers by country

Parameters

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.

This endpoint requires authentication, more info...
Request
path Parameters
country
required
string
header Parameters
Content-Type
string
Example: application/json
Responses
200

Successful response

get/v3/numbers/search/{country}
Request samples 
curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \

'https://rest.clicksend.com/v3/numbers/search/{country}'
Response samples
application/json
{
  • "http_code": 200,
  • "response_code": "SUCCESS",
  • "response_msg": "Here are some numbers.",
  • "data": [
    ],
  • "_currency": {
    }
}

Register Numbers

This endpoint is currently only available for Canada 10DLC number registration.

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.

This endpoint requires authentication, more info...
Request
path Parameters
number_type
required
string

The type of number being registered

Example: 10dlc
country_code
required
string = 2 characters ^[A-Z]{2}$

Two-character ISO country code

Example: US, CA
header Parameters
Content-Type
string
Example: application/json
Request Body schema: application/json
full_name
required
string

Legal full name of the individual registering the number. Must be a personal name, not a business name.

company_name
required
string

Legal business name of the organization requesting registration

email
required
string

Contact email address for registration communications and notifications

website_url
required
string

Official business website URL

sample_message
required
string

Representative example of messages that will be sent using this number

primary_use_case
required
string

Primary intended purpose for the registered number (e.g., Marketing, Notifications, Authentication)

company_number
required
string

Official support phone number of the organization requesting registration

area_code
required
string

Your area codes, please provide your top 3 area codes in case your 1st choice is not available

Responses
200

Successful response

400

Bad request

post/v3/numbers/registrations/number-types/{number_type}/country/{country_code}
Request samples
application/json
{
  • "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",
  • "company_number": "+1-800-555-0199",
  • "area_code": "416, 647, 905"
}
Response samples
application/json
{
  • "http_code": 200,
  • "response_code": "SUCCESS",
  • "response_msg": "Number registration notification sent successfully.",
  • "data": null
}
Copyright © ClickSend 2025. All right reserved.