Sender IDs (1.0.0)

Endpoints associated with creating and managing user accounts.

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

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication, more info...
Request
query Parameters
limit
integer
Example: limit=100
q
string
Example: q=type:sms
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": {
    }
}

Request Alpha Tag

Request to register an alpha tag. After requested, the alpha tag will be reviewed by ClickSend and either approved or rejected.

Properties

Name Type Required Restrictions Description
alpha_tag string true yes The alpha tag name. Length must be between 3 - 11 characters, can only contain a-z A-Z 0-9 + and must contain at least one non numeric.
reason string false none Must be one of the following: Sole Trader Name, Company Name, Partnership Name, Registered Trust Name, Co-Operative Name, Indigenous Corporation Name, Registered Organisation Name, Personal Name, Trademark, Government Agency or Entity, Product or Service Name, Acronym/Initialism, Contraction of Name, Third Party. In case of Third Party, we will contact you to collect the relevant information.

Refer to Status Codes for definitions of HTTP status code responses.

 This endpoint requires authentication, more info...

Request
header Parameters
Content-Type
string
Example: application/json
Request Body schema: application/json
object
Responses
200

Successful response

post/v3/alpha-tags
Request samples
application/json
{
  • "alpha_tag": "Abc123+",
  • "reason": "Sole Trader Name"
}
Response samples
application/json
{
  • "id": "db630385-cb76-457d-8f16-76df1b394257",
  • "account_id": "85edb794-ee6d-4a38-9f63-c5fa8acf0d79",
  • "workspace_id": "85edb794-ee6d-4a38-9f63-c5fa8acf0d79",
  • "user_id": "85edb794-ee6d-4a38-9f63-c5fa8acf0d79",
  • "alpha_tag": "Abc123",
  • "status": "PENDING",
  • "reason": "Sole Trader Name",
  • "created_timestamp": "2021-05-11T01:00:00.123Z",
  • "updated_timestamp": "2021-05-11T01:05:00.123Z"
}

List Alpha Tags

Responses
200

Successful response

get/v3/alpha-tags
Request samples 
curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
'https://rest.clicksend.com/v3/alpha-tags'
Response samples
application/json
{}

Get Alpha Tag

Get a specific alpha tag.

Parameters

Parameter In Type Required Description
alpha_tag_id path uuid true ID of the alpha tag

Refer to Status Codes for definitions of HTTP status code responses.

 This endpoint requires authentication, more info...

Request
path Parameters
alpha_tag_id
required
string
header Parameters
Content-Type
string
Example: application/json
Responses
200

Successful response

get/v3/alpha-tags/{alpha_tag_id}
Request samples 
curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
'https://rest.clicksend.com/v3/alpha-tags/db630385-cb76-457d-8f16-76df1b394257'
Response samples
application/json
{
  • "id": "db630385-cb76-457d-8f16-76df1b394257",
  • "account_id": "85edb794-ee6d-4a38-9f63-c5fa8acf0d79",
  • "workspace_id": "85edb794-ee6d-4a38-9f63-c5fa8acf0d79",
  • "user_id": "85edb794-ee6d-4a38-9f63-c5fa8acf0d79",
  • "alpha_tag": "Abc123",
  • "status": "PENDING",
  • "reason": "Sole Trader Name",
  • "created_timestamp": "2021-05-11T01:00:00.123Z",
  • "updated_timestamp": "2021-05-11T01:05:00.123Z"
}

Delete Alpha Tag

Delete a specific alpha tag.

Parameters

Parameter In Type Required Description
alpha_tag_id path uuid true ID of the alpha tag

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication, more info...

Request
path Parameters
alpha_tag_id
required
string
header Parameters
Content-Type
string
Example: application/json
Responses
200

Successful response

delete/v3/alpha-tags/{alpha_tag_id}
Request samples 
curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
     --request DELETE \
'https://rest.clicksend.com/v3/alpha-tags/db630385-cb76-457d-8f16-76df1b394257'

List Own Numbers

List own numbers.

Parameters

Parameter In Type Required Description
offset query uuid false Page(offset) to be used for pagination. Example: offset=f99872cc-11a6-48ba-a9f2-bcfb6dd1e3d4#8fa5ebc2-777b-45db-a448-ec76a40d4384
page_size query integer false Number of records per page. Default: 10. Range [1..500]
filter[status][] query string false Filter by statuses. Value must be in enum [PENDING, APPROVED, REJECTED]. For example: filter[status][0]=PENDING&filter[status][1]=APPROVED .
sort_by query string false Sort by parameter. Default: created_timestamp
sort_direction query string false Direction of sorting. Default: asc. Value must be in enum [asc, desc].

Refer to Status Codes for definitions of HTTP status code responses.

 This endpoint requires authentication, more info...

Request
header Parameters
Content-Type
string
Example: application/json
Responses
200

Successful response

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

'https://rest.clicksend.com/v3/own-numbers?page_size=50&filter[status][0]=PENDING&filter[status][1]=APPROVED&sort_by=created_timestamp&sort_direction=asc'
Response samples
application/json
{}

Get Own Number Detail

Get a specific own numbers.

Parameters

Parameter In Type Required Description
own_number_id path uuid true ID of the own number

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication, more info...

Request
path Parameters
own_number_id
required
string
header Parameters
Content-Type
string
Example: application/json
Responses
200

Successful response

get/v3/own-numbers/{own_number_id}
Request samples 
curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
     --request GET \

'https://rest.clicksend.com/v3/own-numbers/60b34fe9-1b45-43f8-b9ef-06b7fdb3a9f5'
Response samples
application/json
{
  • "id": "8fa5ebc2-777b-45db-a448-ec76a40d4384",
  • "account_id": "85edb794-ee6d-4a38-9f63-c5fa8acf0d79",
  • "workspace_id": "85edb794-ee6d-4a38-9f63-c5fa8acf0d79",
  • "user_id": "85edb794-ee6d-4a38-9f63-c5fa8acf0d79",
  • "phone_number": "+61412345678",
  • "country": "AU",
  • "label": "My phone number",
  • "status": "APPROVED",
  • "verified_timestamp": "2023-08-31T12:00:00Z",
  • "created_timestamp": "2023-08-25T08:00:00Z",
  • "updated_timestamp": "2023-08-25T08:30:00Z"
}

Update Own Number

Update details of a specific own numbers.

Parameters

Parameter In Type Required Description
own_number_id path uuid true ID of the own number

Properties

Name Type Required Restrictions Description
label string false none Custom label for phone number. Length must be between 1 - 200 characters.

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication, more info...

Request
path Parameters
own_number_id
required
string
Responses
200

Successful response

patch/v3/own-numbers/{own_number_id}
Request samples 
curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
     --request PATCH \
     --data-binary "    {
        \"label\": \"My phone number\"
    }" \

'https://rest.clicksend.com/v3/own-numbers/60b34fe9-1b45-43f8-b9ef-06b7fdb3a9f5'
Response samples
application/json
{
  • "id": "8fa5ebc2-777b-45db-a448-ec76a40d4384",
  • "account_id": "85edb794-ee6d-4a38-9f63-c5fa8acf0d79",
  • "workspace_id": "85edb794-ee6d-4a38-9f63-c5fa8acf0d79",
  • "user_id": "85edb794-ee6d-4a38-9f63-c5fa8acf0d79",
  • "phone_number": "+61412345678",
  • "country": "AU",
  • "label": "My phone number",
  • "status": "APPROVED",
  • "verified_timestamp": "2023-08-31T12:00:00Z",
  • "created_timestamp": "2023-08-25T08:00:00Z",
  • "updated_timestamp": "2023-08-25T08:30:00Z"
}

Delete Own Number

Delete a specific own numbers.

Parameters

Parameter In Type Required Description
own_number_id path uuid true ID of the own number

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication, more info...

Request
path Parameters
own_number_id
required
string
header Parameters
Content-Type
string
Example: application/json
Responses
200

Successful response

delete/v3/own-numbers/{own_number_id}
Request samples 
curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
     --request DELETE \

'https://rest.clicksend.com/v3/own-numbers/60b34fe9-1b45-43f8-b9ef-06b7fdb3a9f5'
Response samples
application/json
{
  • "id": "8fa5ebc2-777b-45db-a448-ec76a40d4384",
  • "account_id": "85edb794-ee6d-4a38-9f63-c5fa8acf0d79",
  • "workspace_id": "85edb794-ee6d-4a38-9f63-c5fa8acf0d79",
  • "user_id": "85edb794-ee6d-4a38-9f63-c5fa8acf0d79",
  • "phone_number": "+61412345678",
  • "country": "AU",
  • "label": "My phone number",
  • "status": "APPROVED",
  • "verified_timestamp": "2023-08-31T12:00:00Z",
  • "created_timestamp": "2023-08-25T08:00:00Z",
  • "updated_timestamp": "2023-08-25T08:30:00Z"
}

Request Own Number Verification OTP

Request to generate own number verification OTP

Properties

Name Type Required Restrictions Description
label string false none Custom label for phone number. Length must be between 1 - 200 characters.
phone_number string true none Phone number.
country string false none Country code.

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication, more info...

Request
header Parameters
Content-Type
string
Example: application/json
Request Body schema: application/json
object
Responses
200

Successful response

post/v3/own-numbers/verifications
Request samples
application/json
{
  • "label": "My phone number",
  • "phone_number": "+61412345678",
  • "country": "AU"
}
Response samples
application/json
{
  • "id": "db630385-cb76-457d-8f16-76df1b394257",
  • "own_number_id": "db630385-cb76-457d-8f16-76df1b394257",
  • "status": "APPROVED",
  • "expires_timestamp": "2023-08-31T12:00:00Z",
  • "remaining_attempts": 2,
  • "created_timestamp": "2023-08-25T08:00:00Z",
  • "updated_timestamp": "2023-08-25T08:10:00Z"
}

Verify Own Number OTP

Request to verify an OTP for Own Number verification

Parameters

Parameter In Type Required Description
verification_id path uuid true ID of the Own Number verification

Properties

Name Type Required Restrictions Description
code string true none OTP code. Length must be 6 characters
phone_number string true none Phone number.
country string false none Country code.

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication, more info...

Request
path Parameters
verification_id
required
string
header Parameters
Content-Type
string
Example: application/json
Request Body schema: application/json
object
Responses
200

Successful response

post/v3/own-numbers/verifications/{verification_id}/verify
Request samples
application/json
{
  • "country": "AU",
  • "phone_number": "+61437887111",
  • "code": "428312"
}
Response samples
application/json
{
  • "id": "db630385-cb76-457d-8f16-76df1b394257",
  • "own_number_id": "db630385-cb76-457d-8f16-76df1b394257",
  • "status": "APPROVED",
  • "expires_timestamp": "2023-08-31T12:00:00Z",
  • "remaining_attempts": 1,
  • "created_timestamp": "2023-08-25T08:00:00Z",
  • "updated_timestamp": "2023-08-25T08:15:00Z"
}
Copyright © ClickSend 2024. All right reserved.