Messages

Send a WhatsApp message from the dashboard

post/api/v1/workspaces/{workspaceId}/messages

Request

  • Base URL: https://otprun.com
  • URL: https://otprun.com/api/v1/workspaces/{workspaceId}/messages
  • Auth: HTTP bearer

Path parameters

workspaceIdinteger required

Request body

project_idinteger required

Project the message is billed and reported under

slot_idstring

Send from this number instead of the automatic choice

textstring required
tostring required

Recipient phone, international format such as +77010000000, or a saved contact name

Response

Accepted

attemptsinteger required
bodystring required
channel'whatsapp_gateway' | 'telegram' | 'telegram_gateway' | 'whatsapp_official' required
contact_namestring required

Name of the recipient in the address book, empty if not saved

created_atstring date-time required
delivered_atstring date-time nullable required
edited_atstring date-time nullable required

When the text was last edited after sending, null if never

error_codestring required
error_detailstring required

The error WhatsApp returned on the last failed attempt, empty when there was none

failed_atstring date-time nullable required
idstring uuid required
outcome'delivered' | 'on_the_way' | 'retrying' | 'unconfirmed' | 'undecrypted' | 'not_delivered' required

What happened to the message in plain terms: unconfirmed means WhatsApp accepted it but the phone has not confirmed it for 10 minutes

project_idinteger required
purpose'notification' | 'otp' required
read_atstring date-time nullable required
revoked_atstring date-time nullable required

When the message was deleted for everyone, null if not

scheduled_atstring date-time required

Earliest moment the gateway sends the message

sent_atstring date-time nullable required
slot_idstring nullable required
status'queued' | 'sending' | 'sent' | 'delivered' | 'read' | 'failed' required
to_phonestring required

Changes

No recorded changes to this operation across all 1 revision of this API.