Register Any Name or Number
A name of your company, brand or customer support number will be displayed as a sender when you send the messages.
Request example:
REQUEST EXAMPLEPOST
POST /senderId HTTP/1.1
Host: api.vertexsms.com
Content-Type: application/json
Accept: application/json
X-VertexSMS-Token: eB52vNTPL9fO3rDrx8pYmVnj6nqceHNhnqceHNh
{ "name" : "TestSender", "type": "AlphaNumeric", "category": "Other", "categoryDescription": "Some description", "notificationUrl": "http://client.com/senderIdCallBack"}
Response example:
RESPONSE · 200 OK
HTTP/1.1 200 OK
Content-Type: plain/text
Cache-control: no-cache
123
If senderId was successfully register - returns HTTP status code 200 OK and ID (123) of the new senderID.
Parameters
| Field | Type | Description |
|---|---|---|
| name | string | Name of the senderID. Maximum sender name length is 11 symbols, minimal - 3. We recommend only using standard alphanumeric characters (upper and lower case) and numbers. The additional symbols: - _ & # ! are allowed but note please that some Network Operators do not always display these characters correctly. |
| type | string | Type of the senderId: AlphaNumeric |
| category | string | Use this to test API without sending real message to handset. Possible values:
|
| categoryDescription | string | Your comments/description. We are required to make sure none of the registered sender names are used without permission. Please provide the following information for verification purposes. |
| notificationUrl | string | Where to send notification about the senderId status changes. Notification will contain the same senderId ID, which is returned after submitting the senderID. |
Register a Mobile Number
Your mobile number will be displayed as a sender when you send the messages and people will be able to reply to you.
Request example:
REQUEST EXAMPLEPOST
POST /senderId HTTP/1.1
Host: api.vertexsms.com
Content-Type: application/json
Accept: application/json
X-VertexSMS-Token: eB52vNTPL9fO3rDrx8pYmVnj6nqceHNhnqceHNh
{ "name" : "37069555555", "type": "MSISDN"}
Response example:
RESPONSE · 200 OK
HTTP/1.1 200 OK
Content-Type: plain/text
Cache-control: no-cache
123
If mobile number was successfully register - returns HTTP status code 200 OK and ID (123) of the new senderID. After that you will receive a 5-digit PIN code (example: 12345) via SMS to this number. In the next step you need to confirm the senderId with the received PIN code.
CONFIRM REQUESTPOST
POST /senderId/confirm/123 HTTP/1.1
Host: api.vertexsms.com
Content-Type: application/json
Accept: application/json
X-VertexSMS-Token: eB52vNTPL9fO3rDrx8pYmVnj6nqceHNhnqceHNh
{ "code" : "12345"}