Send a one-time password to a communication channel.

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

Action method sends generated password to the selected communication channel and provides verification string.
Resource provides a mechanism OTP for the verification using a unique password that can only be used once.

Body Params

external_application_id

string

required

ID of the external application that requested one time password. If you dont have external application id, guide how to get it is available here.

communication_channel_id

integer

required

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

recipient

string

required

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

otp_type

integer

Defaults to 1

Parameter sets witch OTP type should be generated. Possible values: 1 - alphanumeric, 2 - numeric

message_template_id

string

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

Headers

Accept-Language

string

Defaults to cs, en-gb;q=0.8

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

Responses

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.

Language

Credentials

URL


xxxxxxxxxx
11
1
curl --request POST \
2
     --url https://sandbox.crmcarecloud.com/webservice/rest-api/enterprise-interface/v1.0/one-time-password/actions/send \
3
     --header 'Accept-Language: cs, en-gb;q=0.8' \
4
     --header 'accept: application/json' \
5
     --header 'content-type: application/json' \
6
     --data '
7
{
8
  "communication_channel_id": 1,
9
  "otp_type": 1
10
}
11
'


xxxxxxxxxx
 
1
{
2
  "data": {
3
    "request_id": "c27c29917a1dec03ef0673d823619b776ab93353"
4
  }
5
}

200OK

400Bad input parameter. Error message specifies the detail.

401The client has invalid credentials or auth token.

403The client does not exist or the client tried to access non authorized property/resource.

404The resource was not found.

405The resource does not support the specified HTTP method.

500Server is not working as expected.