SMS Based Self Registration
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
JSON Table
| Parameter | Data Type | Description | Manadatory | Default/Sample Value |
|---|---|---|---|---|
| success | boolean | Whether the API call was successful or not. | ||
| message | String | A message indicating the API success or failure. | ||
| data | application/json | A JSON object for the response data. | ||
| data/totalCount | int | The total number of users fetched. | ||
| data/smsServiceConfig | application/json | An array of JSON objects for each guest user account fetched. | ||
| data/smsServiceConfig/service_id | int | The system-generated unique service ID for the user. | ||
| data/smsServiceConfig/name | String | The name of the user | ||
| data/smsServiceConfig/is_default | Boolean | Boolean value if the value is system generated. | ||
| data/smsServiceConfig/type | String | The type of messaging service | ||
| data/smsServiceConfig/msg91_useranme | String | The username of the user | ||
| data/smsServiceConfig/password | int | The passwor dvalue is string value and cannot be left blank. It is a mandatory field. | ||
| data/smsServiceConfig/msg91_sender_id | int | The Id that belongs to the sender of the messages. | ||
| data/smsServiceConfig/sms_route | int | This specifies the route number from which the message is coming. | ||
| data/smsServiceConfig/twilio_account_sid | Date | This specifies the token account number of Twilio account. | ||
| data/smsServiceConfig/twilio_auth_token | Date | This specifies the authorized token id for twilio account. | ||
| data/smsServiceConfig/twilio_from_number | int | This specifies the number from which twilio has sent the message | ||
| data/smsServiceConfig/custom_service_endpoint | int | This | ||
| data/smsServiceConfig/date_created | Date | The date on which it was created. | ||
| data/smsServiceConfig/date_modified | Date | The date on which it was modified. | ||
| data/smsServiceConfig/portals | int | The portal on which it is working. | ||
| data/smsServiceConfig/account_health/twilio/message | String | The authorization for message. | ||
| data/smsServiceConfig/account_health/twilio/last_updated_on | Date | The date on which it was last updated. | ||
| data/smsServiceConfig/account_health/msg91/message | String | The authorization for message. | ||
| data/smsServiceConfig/account_health/msg91/last_updated_on | Date | The date on which it was last updated. | ||
| data/smsServiceConfig/account_health/custom/message/request | String | The request parameters that can be solved. | ||
| data/smsServiceConfig/account_health/custom/message/response | application/json | A JSON representing the status of the last email sent ot the guest. | ||
| data/smsServiceConfig/account_health/last_updated_on | Date | The date on which it was supposedly last updated. | ||
| data/smsServiceConfig/msg91_sms_routes/1 | String | If the route is defined as 1 that means it is a promotional message form | ||
| data/smsServiceConfig/msg91_sms_routes/4 | String | If the route is defined as 4 that means the message type is Transactional. |
Copy Sample JSON
Sample JSON
[
{
"success": true,
"message": "Record(s) Found",
"data": {
"totalCount": 2,
"smsServiceConfig": [
{
"service_id": 2,
"name": "Newconf1",
"is_default": 0,
"type": "twilio",
"msg91_username": "",
"msg91_password": "",
"msg91_sender_id": null,
"msg91_sms_route": 4,
"twilio_account_sid": "ACffaa6c0db22bec04af7f6d20a3fd5e68",
"twilio_auth_token": "bed2b4919cffbbc51b2b9dbcd9fa9d0b",
"twilio_from_number": "+15207779977",
"custom_service_endpoint": null,
"date_created": "2018-02-02 12:02:16.16876",
"date_modified": null,
"portals": [
2
],
"account_health": {
"twilio": {
"message": "Unverified.",
"last_updated_on": ""
},
"msg91": {
"message": "Unverified.",
"last_updated_on": ""
},
"custom": {
"message": {
"request": null,
"response": null
},
"last_updated_on": ""
}
},
"msg91_sms_routes": {
"1": "Promotional",
"4": "Transactional"
}
},
{
"service_id": 1,
"name": "SMS",
"is_default": 1,
"type": "twilio",
"msg91_username": "rohanvr_21",
"msg91_password": "437724",
"msg91_sender_id": "ATNFSF",
"msg91_sms_route": 4,
"twilio_account_sid": "ACffaa6c0db22bec04af7f6d20a3fd5e68",
"twilio_auth_token": "bed2b4919cffbbc51b2b9dbcd9fa9d0b",
"twilio_from_number": "+15207779977",
"custom_service_endpoint": "",
"date_created": "2017-09-11 06:38:35.791836",
"date_modified": "2018-02-02 12:03:34.914335",
"portals": [],
"account_health": {
"twilio": {
"message": "Unverified.",
"last_updated_on": ""
},
"msg91": {
"message": "Unverified.",
"last_updated_on": ""
},
"custom": {
"message": {
"request": null,
"response": null
},
"last_updated_on": ""
}
},
"msg91_sms_routes": {
"1": "Promotional",
"4": "Transactional"
}
}
]
}
}
]
API Calls
V14/services/sms/config
V14/services/sms/config
V14/services/sms/config/configid
V14/services/sms/config/${configId}
V14/services/sms/config/${configId}