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

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
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": {
    }
}
Copyright © ClickSend 2024. All right reserved.