buyNumberRequest = new HashMap<>();\n buyNumberRequest.put(\"dedicated_number\", \"+614197651956\");\n buyNumberRequest.put(\"type\", \"sms\");\n buyNumberRequest.put(\"registration_data\", registrationData);\n \n String dedicatedNumber = \"+614197651956\"; // String | Phone number to purchase\n try {\n String result = apiInstance.numbersBuyByDedicatedNumberPost(dedicatedNumber, buyNumberRequest);\n System.out.println(result);\n } catch (ApiException e) {\n System.err.println(\"Exception when calling NumberApi#numbersBuyByDedicatedNumberPost\");\n e.printStackTrace();\n }\n }\n}"
},
{
"lang": "Node.js",
"source": "var api = require('./api.js');\n\nvar numberApi = new api.NumberApi(\"USERNAME\", \"API_KEY\");\n\n// Define the request body\nvar buyNumberRequest = {\n dedicated_number: \"+614197651956\",\n type: \"sms\",\n registration_data: {\n business_name: \"ABD\",\n business_address: \"242 Exhibition Street\",\n suburb: \"Melbourne\",\n postcode: \"3000\",\n state: \"Victoria\",\n contact_name: \"ABD\",\n contact_number: \"+614197651956\",\n country: \"AU\"\n }\n};\n\nvar dedicatedNumber = \"+614197651956\";\n\nnumberApi.numbersBuyByDedicatedNumberPost(dedicatedNumber, buyNumberRequest).then(function(response) {\n console.log(response.body);\n}).catch(function(err){\n console.error(err.body);\n});"
},
{
"lang": "Ruby",
"source": "# load the gem\nrequire 'clicksend_client'\nrequire 'json'\n\n# setup authorization\nClickSendClient.configure do |config|\n # Configure HTTP basic authorization: BasicAuth\n config.username = 'USERNAME'\n config.password = 'API_KEY'\nend\n\napi_instance = ClickSendClient::NumberApi.new\n\n# Define the request body\nbuy_number_request = {\n dedicated_number: \"+614197651956\",\n type: \"sms\",\n registration_data: {\n business_name: \"ABD\",\n business_address: \"242 Exhibition Street\",\n suburb: \"Melbourne\",\n postcode: \"3000\",\n state: \"Victoria\",\n contact_name: \"ABD\",\n contact_number: \"+614197651956\",\n country: \"AU\"\n }\n}\n\ndedicated_number = \"+614197651956\" # String | Phone number to purchase\n\nbegin\n # Buy dedicated number\n result = api_instance.numbers_buy_by_dedicated_number_post(dedicated_number, buy_number_request)\n p JSON.parse(result)\nrescue ClickSendClient::ApiError => e\n puts \"Exception when calling NumberApi->numbers_buy_by_dedicated_number_post: #{e.response_body}\"\nend"
},
{
"lang": "Python",
"source": "from __future__ import print_function\nimport clicksend_client\nfrom clicksend_client.rest import ApiException\n\n# Configure HTTP basic authorization: BasicAuth\nconfiguration = clicksend_client.Configuration()\nconfiguration.username = 'USERNAME'\nconfiguration.password = 'API_KEY'\n\n# create an instance of the API class\napi_instance = clicksend_client.NumberApi(clicksend_client.ApiClient(configuration))\n\n# Define the request body\nbuy_number_request = {\n \"dedicated_number\": \"+614197651956\",\n \"type\": \"sms\",\n \"registration_data\": {\n \"business_name\": \"ABD\",\n \"business_address\": \"242 Exhibition Street\",\n \"suburb\": \"Melbourne\",\n \"postcode\": \"3000\",\n \"state\": \"Victoria\",\n \"contact_name\": \"ABD\",\n \"contact_number\": \"+614197651956\",\n \"country\": \"AU\"\n }\n}\n\ndedicated_number = '+614197651956' # str | Phone number to purchase\n\ntry:\n # Buy dedicated number\n api_response = api_instance.numbers_buy_by_dedicated_number_post(dedicated_number, buy_number_request)\n print(api_response)\nexcept ApiException as e:\n print(\"Exception when calling NumberApi->numbers_buy_by_dedicated_number_post: %s\\n\" % e)"
},
{
"lang": "perl",
"source": "use WWW::ClickSendClient::NumberApi;\n\nmy $username = 'YOUR_API_USER_NAME';\nmy $password = 'YOUR_API_PASSWORD';\n\nmy $api = WWW::ClickSendClient::NumberApi->new(username => $username, password => $password);\n\n# Define the request body\nmy %buy_number_request = (\n 'dedicated_number' => '+614197651956',\n 'type' => 'sms',\n 'registration_data' => {\n 'business_name' => 'ABD',\n 'business_address' => '242 Exhibition Street',\n 'suburb' => 'Melbourne',\n 'postcode' => '3000',\n 'state' => 'Victoria',\n 'contact_name' => 'ABD',\n 'contact_number' => '+614197651956',\n 'country' => 'AU'\n }\n);\n\nmy $json_output = $api->numbers_buy_by_dedicated_number_post('dedicated_number' => '+614197651956', 'buy_number_request' => \\%buy_number_request);\n\nprint $json_output;"
},
{
"lang": "objc",
"source": "#import \"CSNumberApi.h\"\n\nCSDefaultConfiguration *apiConfig = [CSDefaultConfiguration sharedConfig];\n[apiConfig setUsername:@\"USERNAME\"];\n[apiConfig setPassword:@\"PASSWORD\"];\n\n// Define the request body\nNSDictionary *registrationData = @{\n @\"business_name\": @\"ABD\",\n @\"business_address\": @\"242 Exhibition Street\",\n @\"suburb\": @\"Melbourne\",\n @\"postcode\": @\"3000\",\n @\"state\": @\"Victoria\",\n @\"contact_name\": @\"ABD\",\n @\"contact_number\": @\"+614197651956\",\n @\"country\": @\"AU\"\n};\n\nNSDictionary *buyNumberRequest = @{\n @\"dedicated_number\": @\"+614197651956\",\n @\"type\": @\"sms\",\n @\"registration_data\": registrationData\n};\n\nCSNumberApi *numberApiInstance = [[CSNumberApi alloc] init];\n[numberApiInstance numbersBuyByDedicatedNumberPostWithDedicatedNumber:@\"+614197651956\" \n buyNumberRequest:buyNumberRequest \n completionHandler:^(NSString *output, NSError *error) {\n if (error) {\n NSLog(@\"Error: %@\", error);\n } else {\n NSLog(@\"%@\", output);\n }\n}];"
},
{
"lang": "swift",
"source": "import Alamofire\n\nif let authHeader = Request.authorizationHeader(user: \"USERNAME\", password: \"PASSWORD\") {\n ClickSendClientAPI.customHeaders = [authHeader.key : authHeader.value]\n}\n\n// Define the request body\nlet registrationData: [String: Any] = [\n \"business_name\": \"ABD\",\n \"business_address\": \"242 Exhibition Street\",\n \"suburb\": \"Melbourne\",\n \"postcode\": \"3000\",\n \"state\": \"Victoria\",\n \"contact_name\": \"ABD\",\n \"contact_number\": \"+614197651956\",\n \"country\": \"AU\"\n]\n\nlet buyNumberRequest: [String: Any] = [\n \"dedicated_number\": \"+614197651956\",\n \"type\": \"sms\",\n \"registration_data\": registrationData\n]\n\nNumberAPI.numbersBuyByDedicatedNumberPost(dedicatedNumber: \"+614197651956\", buyNumberRequest: buyNumberRequest) { (dataString, error) in\n guard let dataString = dataString else {\n print(error!)\n return\n }\n if let data = dataString.data(using: String.Encoding.utf8) {\n do {\n if let dictonary = try (JSONSerialization.jsonObject(with: data, options: []) as? NSDictionary) {\n print(dictonary)\n } else {\n print(\"Cannot convert the String value to JSON\")\n }\n } catch let error as NSError {\n print(error)\n }\n }\n}"
}
]
}
},
"/v3/numbers/search/{country}": {
"get": {
"summary": "View Available Numbers",
"operationId": "view-available-numbers",
"description": "_Get all dedicated numbers by country_\n\n### Parameters\n\n| Parameter | In | Type | Required | Description |\n| --- | --- | --- | --- | --- |\n| country | path | string | true | Country code to search |\n| search | query | string | false | Your search pattern or query. |\n| search_type | query | integer(int32) | false | Your strategy for searching, 0 = starts with, 1 = anywhere, 2 = ends with. |\n| page | query | integer(int32) | false | [Page number](/#pagination) |\n| limit | query | integer(int32) | false | [Number of records per page](/#pagination) |\n\n\nRefer to [Status Codes](/#status-codes) for definitions of HTTP status code responses.\n\n\n",
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"schema": {
"type": "string"
},
"example": "application/json"
},
{
"name": "country",
"in": "path",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/view-available-numbers"
}
}
}
}
},
"x-codeSamples": [
{
"lang": "curl",
"source": "curl --include \\\n --header \"Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA==\" \\\n\n'https://rest.clicksend.com/v3/numbers/search/{country}'"
},
{
"lang": "PHP",
"source": "setUsername('USERNAME')\n ->setPassword('API_KEY');\n\n$apiInstance = new ClickSend\\Api\\NumberApi(new GuzzleHttp\\Client(),$config);\n$country = \"US\"; // string | Country code to search\n$search = \"\"; // string | Your search pattern or query.\n$search_type = 56; // int | Your strategy for searching, 0 = starts with, 1 = anywhere, 2 = ends with.\n$page = 1; // int | Page number\n$limit = 10; // int | Number of records per page\n\ntry {\n $result = $apiInstance->numbersSearchByCountryGet($country, $search, $search_type, $page, $limit);\n print_r($result);\n} catch (Exception $e) {\n echo 'Exception when calling NumberApi->numbersSearchByCountryGet: ', $e->getMessage(), PHP_EOL;\n}\n?>"
},
{
"lang": "C#",
"source": "using IO.ClickSend.ClickSend.Api;\nusing IO.ClickSend.Client;\nusing IO.ClickSend.ClickSend.Model;\n\nvar configuration = new Configuration()\n{\n Username = USERNAME, \n Password = API_KEY \n};\nvar numberApi = new NumberApi(configuration);\nvar response = numberApi.NumbersSearchByCountryGet(\"CA\");"
},
{
"lang": "Java",
"source": "package ClickSend;\n\nimport ClickSend.Api.NumberApi;\n\npublic class view_available_numbers {\n public static void main(String[] args) {\n ApiClient defaultClient = new ApiClient();\n defaultClient.setUsername(\"USERNAME\");\n defaultClient.setPassword(\"API_KEY\");\n NumberApi apiInstance = new NumberApi(defaultClient);\n String country = \"US\"; // String | Country code to search\n String search = \"\"; // String | Your search pattern or query.\n Integer searchType = 1; // Integer | Your strategy for searching, 0 = starts with, 1 = anywhere, 2 = ends with.\n Integer page = 1; // Integer | Page number\n Integer limit = 10; // Integer | Number of records per page\n try {\n String result = apiInstance.numbersSearchByCountryGet(country, search, searchType, page, limit);\n System.out.println(result);\n } catch (ApiException e) {\n System.err.println(\"Exception when calling NumberApi#numbersSearchByCountryGet\");\n e.printStackTrace();\n }\n }\n}"
},
{
"lang": "Node.js",
"source": "var api = require('./api.js');\n\nvar numberApi = new api.NumberApi(\"USERNAME\", \"API_KEY\");\n\nvar country = \"US\";\nvar search = \"\";\nvar searchType = 1;\nvar page = 1;\nvar limit = 10;\n\nnumberApi.numbersSearchByCountryGet(country, search, searchType, page, limit).then(function(response) {\n console.log(response.body);\n}).catch(function(err){\n console.error(err.body);\n});"
},
{
"lang": "Ruby",
"source": "# load the gem\nrequire 'clicksend_client'\nrequire 'json'\n\n# setup authorization\nClickSendClient.configure do |config|\n # Configure HTTP basic authorization: BasicAuth\n config.username = 'USERNAME'\n config.password = 'API_KEY'\nend\n\napi_instance = ClickSendClient::NumberApi.new\n\ncountry = \"US\" # String | Country code to search\n\nopts = {\n \"search\": \"88\", # String | Your search pattern or query.\n \"search_type\": 1, # Integer | Your strategy for searching,\n # 0 = starts with, 1 = anywhere, 2 = ends with.\n \"page\": 1, # Integer | Page number\n \"limit\": 10 # Integer | Number of records per page\n}\n\nbegin\n # Get all dedicated numbers by country\n result = api_instance.numbers_search_by_country_get(country, opts)\n p JSON.parse(result)\nrescue ClickSendClient::ApiError => e\n puts \"Exception when calling NumberApi->numbers_search_by_country_get: #{e.response_body}\"\nend"
},
{
"lang": "Python",
"source": "from __future__ import print_function\nimport clicksend_client\nfrom clicksend_client.rest import ApiException\n\n# Configure HTTP basic authorization: BasicAuth\nconfiguration = clicksend_client.Configuration()\nconfiguration.username = 'USERNAME'\nconfiguration.password = 'API_KEY'\n\n# create an instance of the API class\napi_instance = clicksend_client.NumberApi(clicksend_client.ApiClient(configuration))\ncountry = 'country_example' # str | Country code to search\nsearch = 'search_example' # str | Your search pattern or query. (optional)\nsearch_type = 56 # int | Your strategy for searching, 0 = starts with, 1 = anywhere, 2 = ends with. (optional)\npage = 1 # int | Page number (optional) (default to 1)\nlimit = 10 # int | Number of records per page (optional) (default to 10)\n\ntry:\n # Get all dedicated numbers by country\n api_response = api_instance.numbers_search_by_country_get(country, search=search, search_type=search_type, page=page, limit=limit)\n print(api_response)\nexcept ApiException as e:\n print(\"Exception when calling NumberApi->numbers_search_by_country_get: %s\\n\" % e)"
},
{
"lang": "perl",
"source": "use WWW::ClickSendClient::NumberApi;\n\nmy $username = 'YOUR_API_USER_NAME';\nmy $password = 'YOUR_API_PASSWORD';\n\nmy $api = WWW::ClickSendClient::NumberApi->new(username => $username, password => $password);\n\nmy $json_output = $api->numbers_search_by_country_get('country' => 'AU' ,'search' => '' ,'search_type' => '', 'page' => '','limit' => '' );\n\nprint $json_output;"
},
{
"lang": "objc",
"source": "#import \"CSNumberApi.h\"\n\nCSDefaultConfiguration *apiConfig = [CSDefaultConfiguration sharedConfig];\n[apiConfig setUsername:@\"USERNAME\"];\n[apiConfig setPassword:@\"PASSWORD\"];\n\nNSNumber *searchType = [[NSNumber alloc] initWithInt:1];\nNSNumber *page = [[NSNumber alloc] initWithInt:1];\nNSNumber *limit = [[NSNumber alloc] initWithInt:15];\n\nCSNumberApi *numberApiInstance = [[CSNumberApi alloc] init];\n[numberApiInstance numbersSearchByCountryGetWithCountry: @\"country\" search:@\"search\" searchType:searchType page:page limit:limit completionHandler:^(NSString *output, NSError *error) {\n if (error) {\n NSLog(@\"Error: %@\", error);\n } else {\n NSLog(@\"%@\", output);\n }\n}];"
},
{
"lang": "swift",
"source": "import Alamofire\n\nif let authHeader = Request.authorizationHeader(user: \"USERNAME\", password: \"PASSWORD\") {\n ClickSendClientAPI.customHeaders = [authHeader.key : authHeader.value]\n}\n\nNumberAPI.numbersSearchByCountryGet(country: \"country\", search: \"search\", searchType: nil, page: 1, limit: 15) { (dataString, error) in\n guard let dataString = dataString else {\n print(error!)\n return\n }\n if let data = dataString.data(using: String.Encoding.utf8) {\n do {\n if let dictonary = try (JSONSerialization.jsonObject(with: data, options: []) as? NSDictionary) {\n print(dictonary)\n } else {\n print(\"Cannot convert the String value to JSON\")\n }\n } catch let error as NSError {\n print(error)\n }\n }\n}"
}
]
}
},
"/v3/numbers/registrations/number-types/{number_type}/country/{country_code}": {
"post": {
"summary": "Register Numbers",
"operationId": "register-numbers",
"description": "\nThis endpoint is currently only available for Canada 10DLC number registration.\n
\n\nRegisters a number that requires additional verification information. This endpoint facilitates the registration process for numbers requiring special compliance documentation.\n\nAfter submission, ClickSend's compliance team will review the registration and notify you of the approval status.\n\nRefer to [Status Codes](/#status-codes) for definitions of HTTP status code responses.\n",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"full_name": {
"type": "string",
"description": "Legal full name of the individual registering the number. Must be a personal name, not a business name.",
"example": "John Doe"
},
"company_name": {
"type": "string",
"description": "Legal business name of the organization requesting registration",
"example": "ClickSend"
},
"email": {
"type": "string",
"description": "Contact email address for registration communications and notifications",
"example": "john.doe@clicksend.com"
},
"website_url": {
"type": "string",
"description": "Official business website URL",
"example": "https://clicksend.com"
},
"sample_message": {
"type": "string",
"description": "Representative example of messages that will be sent using this number",
"example": "Get 20% off on your next purchase! Visit our website for details."
},
"primary_use_case": {
"type": "string",
"description": "Primary intended purpose for the registered number (e.g., Marketing, Notifications, Authentication)",
"example": "Marketing"
},
"company_number": {
"type": "string",
"description": "Official support phone number of the organization requesting registration",
"example": "+1-800-555-0199"
},
"area_code": {
"type": "string",
"description": "Your area codes, please provide your top 3 area codes in case your 1st choice is not available",
"example": "416, 647, 905"
}
},
"required": [
"full_name",
"company_name",
"email",
"website_url",
"sample_message",
"primary_use_case",
"company_number",
"area_code"
],
"example": {
"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"
}
}
}
}
},
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"schema": {
"type": "string"
},
"example": "application/json"
},
{
"name": "number_type",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The type of number being registered",
"example": "10dlc"
},
{
"name": "country_code",
"in": "path",
"required": true,
"schema": {
"type": "string",
"minLength": 2,
"maxLength": 2,
"pattern": "^[A-Z]{2}$"
},
"description": "Two-character ISO country code",
"example": "US, CA"
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/register_numbers"
},
"example": {
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Number registration notification sent successfully.",
"data": null
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400_error"
}
}
}
}
},
"x-codeSamples": [
{
"lang": "curl",
"source": "curl --include \\\n --header \"Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA==\" \\\n --request POST \\\n --header \"Content-Type: application/json\" \\\n --data-binary \" {\n \\\"full_name\\\": \\\"John Doe\\\",\n \\\"company_name\\\": \\\"Clicksend\\\",\n \\\"email\\\": \\\"john.doe@clicksend.com\\\",\n \\\"website_url\\\": \\\"https://clicksend.com\\\",\n \\\"sample_message\\\": \\\"Get 20% off on your next purchase! Visit our website for details.\\\",\n \\\"primary_use_case\\\": \\\"Marketing\\\"\n }\" \\\n'https://rest.clicksend.com/v3/numbers/registrations/number-types/{number_type}/country/{country_code}'"
}
]
}
}
}
}