MsisdnEndpoint
The following resources are applicable:
- /msisdn/check/key
- /msisdn/check/pin
- /msisdn/create/key
- /msisdn/verify
- /msisdn/verify/call
- /msisdn/verify/status
/msisdn/check/key
Mount Point: /rest/msisdn/check/key
POST
Checks if previously created key has been received on one of our recipient addresses
Error Codes
| 2 | A required parameter was not given |
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 403 | The msisdn verify key is not verified |
| 600 | The api key is invalid |
Request Body
| element: | msisdnVerifyCheckKeyRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | msisdnVerifyCheckKeyResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/msisdn/check/pin
Mount Point: /rest/msisdn/check/pin
POST
Checks if a pin is valid
Error Codes
| 2 | A required parameter was not given |
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 400 | The msisdn verify pin is invalid |
| 404 | The check is blocked for a specific time, because some wrong checks were made |
| 600 | The api key is invalid |
Request Body
| element: | msisdnVerifyCheckPinRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | msisdnVerifyCheckPinResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/msisdn/create/key
Mount Point: /rest/msisdn/create/key
POST
Creates a verify key. This key must be send to one of our recipient numbers (see config countries)
Error Codes
| 2 | A required parameter was not given |
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 600 | The api key is invalid |
Request Body
| element: | msisdnVerifyCreateKeyRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | msisdnVerifyCreateKeyResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/msisdn/verify
Mount Point: /rest/msisdn/verify
POST
Sends a verify pin to a mobile number. Optionally you can trigger a flash sms (normally not stored on handset and displayed via popup).
Error Codes
| 2 | A required parameter was not given |
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 401 | The msisdn verification was blocked, because the pin was requested shortly. Use the last pin or wait some time |
| 402 | The msisdn verification for the given msisdn was blocked by the system |
| 500 | The country is not allowed to login or register |
| 501 | The msisdn is invalid for the country |
| 600 | The api key is invalid |
Request Body
| element: | msisdnVerifyRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | msisdnVerifyResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/msisdn/verify/call
Mount Point: /rest/msisdn/verify/call
POST
Calls a msisdn and reads a verify pin.
Error Codes
| 2 | A required parameter was not given |
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 401 | The msisdn verification was blocked, because the pin was requested shortly. Use the last pin or wait some time |
| 402 | The msisdn verification for the given msisdn was blocked by the system |
| 500 | The country is not allowed to login or register |
| 501 | The msisdn is invalid for the country |
| 600 | The api key is invalid |
Request Body
| element: | msisdnVerifyCallRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | msisdnVerifyCallResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/msisdn/verify/status
Mount Point: /rest/msisdn/verify/status
POST
Get the status of the verify sms.
Error Codes
| 2 | A required parameter was not given |
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 600 | The api key is invalid |
Request Body
| element: | msisdnVerifyStatusRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | msisdnVerifyStatusResponse |
| media types: | */* application/xml application/json |
(no documentation provided)