Schedule Message
curl --request POST \
--url https://api.decodahealth.com/comms/chat/schedule-message \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TENANT: <tenant>' \
--data '
{
"chatId": "<string>",
"senderId": "<string>",
"content": "<string>",
"sendAt": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.decodahealth.com/comms/chat/schedule-message"
payload = {
"chatId": "<string>",
"senderId": "<string>",
"content": "<string>",
"sendAt": "2023-11-07T05:31:56Z"
}
headers = {
"TENANT": "<tenant>",
"API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
chatId: '<string>',
senderId: '<string>',
content: '<string>',
sendAt: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.decodahealth.com/comms/chat/schedule-message', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.decodahealth.com/comms/chat/schedule-message",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'chatId' => '<string>',
'senderId' => '<string>',
'content' => '<string>',
'sendAt' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"Content-Type: application/json",
"TENANT: <tenant>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.decodahealth.com/comms/chat/schedule-message"
payload := strings.NewReader("{\n \"chatId\": \"<string>\",\n \"senderId\": \"<string>\",\n \"content\": \"<string>\",\n \"sendAt\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("TENANT", "<tenant>")
req.Header.Add("API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.decodahealth.com/comms/chat/schedule-message")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"chatId\": \"<string>\",\n \"senderId\": \"<string>\",\n \"content\": \"<string>\",\n \"sendAt\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/comms/chat/schedule-message")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"chatId\": \"<string>\",\n \"senderId\": \"<string>\",\n \"content\": \"<string>\",\n \"sendAt\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"chatId": "<string>",
"content": "<string>",
"sendAt": "2023-11-07T05:31:56Z",
"sender": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"email": "<string>",
"locationId": "<string>"
},
"createdDate": "2023-11-07T05:31:56Z",
"sentAt": "2023-11-07T05:31:56Z",
"sentMessageId": "<string>",
"errorMessage": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Messages
Schedule Message
Queue a text to send into a patient chat at a future time.
The heartbeat sweep sends it through the normal send path when due.
POST
/
comms
/
chat
/
schedule-message
Schedule Message
curl --request POST \
--url https://api.decodahealth.com/comms/chat/schedule-message \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TENANT: <tenant>' \
--data '
{
"chatId": "<string>",
"senderId": "<string>",
"content": "<string>",
"sendAt": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.decodahealth.com/comms/chat/schedule-message"
payload = {
"chatId": "<string>",
"senderId": "<string>",
"content": "<string>",
"sendAt": "2023-11-07T05:31:56Z"
}
headers = {
"TENANT": "<tenant>",
"API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
chatId: '<string>',
senderId: '<string>',
content: '<string>',
sendAt: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.decodahealth.com/comms/chat/schedule-message', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.decodahealth.com/comms/chat/schedule-message",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'chatId' => '<string>',
'senderId' => '<string>',
'content' => '<string>',
'sendAt' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"Content-Type: application/json",
"TENANT: <tenant>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.decodahealth.com/comms/chat/schedule-message"
payload := strings.NewReader("{\n \"chatId\": \"<string>\",\n \"senderId\": \"<string>\",\n \"content\": \"<string>\",\n \"sendAt\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("TENANT", "<tenant>")
req.Header.Add("API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.decodahealth.com/comms/chat/schedule-message")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"chatId\": \"<string>\",\n \"senderId\": \"<string>\",\n \"content\": \"<string>\",\n \"sendAt\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/comms/chat/schedule-message")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"chatId\": \"<string>\",\n \"senderId\": \"<string>\",\n \"content\": \"<string>\",\n \"sendAt\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"chatId": "<string>",
"content": "<string>",
"sendAt": "2023-11-07T05:31:56Z",
"sender": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"email": "<string>",
"locationId": "<string>"
},
"createdDate": "2023-11-07T05:31:56Z",
"sentAt": "2023-11-07T05:31:56Z",
"sentMessageId": "<string>",
"errorMessage": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Headers
The tenant you are making this request on behalf of
Your api key
Body
application/json
Response
Successful Response
Available options:
SCHEDULED, SENT, CANCELLED, FAILED Show child attributes
Show child attributes
⌘I
