Send Message To Channel

You can send a string as a message.

You can send messages either as a patient or as the affiliate using the sender parameter.

Please specify the channelType to determine which channel the message should be sent to: clinical, billing, or support.

You can send either a text message or a file:

  • To send a text message, use the message field and specify the text as its value.

  • To send a file, use the file field and provide the following object as its value:

{
  "name": "<file-name>",
  "ext": "<file-extension>",
  "base64Data": "<file-base64>"
}

IMPORTANT: The base64 data must not include a MIME header (e.g. data:image/png;base64,...). Only provide the raw base64 string.

Make sure the file extension is correct.

You can also omit the file extension—if so, the file will be downloaded to the device when accessed in the chat.

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

Send a message.

You can send messages either as a patient or as the affiliate using the sender parameter.Please specify the channelType to determine which channel the message should be sent to: clinical, billing, or support.

{
    "message": "Hi from API",
    "sender": "patient", // use ['patient', 'affiliate-admin']
    "channelType": "clinical" // you can use ['clinical', 'billing', 'support']
}

To send a text message, use the message field and specify the text as its value. -

Send a file.

{
  "message": {
    "name": "<file-name>",
    "ext": "<file-extension>",
    "base64Data": "<file-base64>"
  },
  "sender": "patient",
  "channelType": "clinical"

}

IMPORTANT: The base64 data must not include a MIME header (e.g. data:image/png;base64,...). Only provide the raw base64 string.Make sure the file extension is correct.You can also omit the file extension—if so, the file will be downloaded to the device when accessed in the chat.

📘

IFrame only available for those using the Telegra Patient Dashboard


Path Params
string
required
Response

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