Own Numbers (1.0.0)

API endpoints for managing and verifying user-owned numbers as sender IDs for messaging services.

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",
  • "is_nearing_expiration": true,
  • "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",
  • "is_nearing_expiration": true,
  • "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",
  • "is_nearing_expiration": true,
  • "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.