API Reference

Send a one-time password to a communication channel.

post
https://{project_url}/webservice/rest-api/{api_interface}/{version}/one-time-password/actions/send

Sends a one-time password to the selected communication channel and returns a request ID used for verification.
The password is valid for 1 hour by default and can only be used once. Use the request ID with
POST /one-time-password/actions/verify to complete verification.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The unique ID of the external application that requested the one-time password. If you do not have an external application ID, see the authentication documentation.

integer
enum
required

The unique ID of the communication channel. Possible values: 1 - email, 2 - SMS, 4 - push notification (Apple or Google), 5 - internal system notification.

Allowed:
string
required

Recipient of the message with OTP. The parameter could contain email, phone number or other identifier of the message recipient.

integer
enum
Defaults to 1

Sets the OTP type to generate. Possible values: 1 - alphanumeric, 2 - numeric.

Allowed:
string

The unique ID of the message template. If not set, CareCloud uses the default value from the system configuration.

Headers
string
Defaults to cs, en-gb;q=0.8

The unique ID of the language code by ISO 639-1.

Responses

error.error_data.invalid_params[] array lists the parameters that caused the failure, each carrying a reason code. See the BadRequestErrorBody schema for the generic reason taxonomy. Operations with domain-specific business rules document additional reasons at the operation level.

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Updated 25 days ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 25 days ago