Create outbound SMS chat

curl --request POST \
  --url https://api.upon-ai.com/api/chats/outbound-sms \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspaceId": 42,
  "agent_id": "chat_agent_01hzk4q6dr3n0d4qzpw9z6gth6",
  "from_number": "+14155550100",
  "to_number": "+14155550199",
  "metadata": {
    "campaign": "reactivation"
  },
  "uponai_dynamic_variables": {
    "customer_first_name": "Jamie"
  }
}
'

import requests

url = "https://api.upon-ai.com/api/chats/outbound-sms"

payload = {
    "workspaceId": 42,
    "agent_id": "chat_agent_01hzk4q6dr3n0d4qzpw9z6gth6",
    "from_number": "+14155550100",
    "to_number": "+14155550199",
    "metadata": { "campaign": "reactivation" },
    "uponai_dynamic_variables": { "customer_first_name": "Jamie" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    workspaceId: 42,
    agent_id: 'chat_agent_01hzk4q6dr3n0d4qzpw9z6gth6',
    from_number: '+14155550100',
    to_number: '+14155550199',
    metadata: {campaign: 'reactivation'},
    uponai_dynamic_variables: {customer_first_name: 'Jamie'}
  })
};

fetch('https://api.upon-ai.com/api/chats/outbound-sms', 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.upon-ai.com/api/chats/outbound-sms",
  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([
    'workspaceId' => 42,
    'agent_id' => 'chat_agent_01hzk4q6dr3n0d4qzpw9z6gth6',
    'from_number' => '+14155550100',
    'to_number' => '+14155550199',
    'metadata' => [
        'campaign' => 'reactivation'
    ],
    'uponai_dynamic_variables' => [
        'customer_first_name' => 'Jamie'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.upon-ai.com/api/chats/outbound-sms"

	payload := strings.NewReader("{\n  \"workspaceId\": 42,\n  \"agent_id\": \"chat_agent_01hzk4q6dr3n0d4qzpw9z6gth6\",\n  \"from_number\": \"+14155550100\",\n  \"to_number\": \"+14155550199\",\n  \"metadata\": {\n    \"campaign\": \"reactivation\"\n  },\n  \"uponai_dynamic_variables\": {\n    \"customer_first_name\": \"Jamie\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.upon-ai.com/api/chats/outbound-sms")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workspaceId\": 42,\n  \"agent_id\": \"chat_agent_01hzk4q6dr3n0d4qzpw9z6gth6\",\n  \"from_number\": \"+14155550100\",\n  \"to_number\": \"+14155550199\",\n  \"metadata\": {\n    \"campaign\": \"reactivation\"\n  },\n  \"uponai_dynamic_variables\": {\n    \"customer_first_name\": \"Jamie\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.upon-ai.com/api/chats/outbound-sms")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"workspaceId\": 42,\n  \"agent_id\": \"chat_agent_01hzk4q6dr3n0d4qzpw9z6gth6\",\n  \"from_number\": \"+14155550100\",\n  \"to_number\": \"+14155550199\",\n  \"metadata\": {\n    \"campaign\": \"reactivation\"\n  },\n  \"uponai_dynamic_variables\": {\n    \"customer_first_name\": \"Jamie\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "chatId": "<string>",
  "agentId": "<string>",
  "version": 123,
  "status": "<string>",
  "type": "web_chat",
  "metadata": {},
  "customAttributes": {},
  "startedAt": "2023-11-07T05:31:56Z",
  "endedAt": "2023-11-07T05:31:56Z",
  "transcript": "<string>",
  "messages": [
    {
      "content": "<string>",
      "name": "<string>",
      "tool_calls": [
        {}
      ]
    }
  ],
  "chatCost": {},
  "chatAnalysis": {},
  "collectedDynamicVariables": {},
  "uponai_dynamic_variables": {},
  "overrideDynamicVariables": {}
}

POST

api

chats

outbound-sms

Create outbound SMS chat

curl --request POST \
  --url https://api.upon-ai.com/api/chats/outbound-sms \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspaceId": 42,
  "agent_id": "chat_agent_01hzk4q6dr3n0d4qzpw9z6gth6",
  "from_number": "+14155550100",
  "to_number": "+14155550199",
  "metadata": {
    "campaign": "reactivation"
  },
  "uponai_dynamic_variables": {
    "customer_first_name": "Jamie"
  }
}
'

import requests

url = "https://api.upon-ai.com/api/chats/outbound-sms"

payload = {
    "workspaceId": 42,
    "agent_id": "chat_agent_01hzk4q6dr3n0d4qzpw9z6gth6",
    "from_number": "+14155550100",
    "to_number": "+14155550199",
    "metadata": { "campaign": "reactivation" },
    "uponai_dynamic_variables": { "customer_first_name": "Jamie" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    workspaceId: 42,
    agent_id: 'chat_agent_01hzk4q6dr3n0d4qzpw9z6gth6',
    from_number: '+14155550100',
    to_number: '+14155550199',
    metadata: {campaign: 'reactivation'},
    uponai_dynamic_variables: {customer_first_name: 'Jamie'}
  })
};

fetch('https://api.upon-ai.com/api/chats/outbound-sms', 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.upon-ai.com/api/chats/outbound-sms",
  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([
    'workspaceId' => 42,
    'agent_id' => 'chat_agent_01hzk4q6dr3n0d4qzpw9z6gth6',
    'from_number' => '+14155550100',
    'to_number' => '+14155550199',
    'metadata' => [
        'campaign' => 'reactivation'
    ],
    'uponai_dynamic_variables' => [
        'customer_first_name' => 'Jamie'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.upon-ai.com/api/chats/outbound-sms"

	payload := strings.NewReader("{\n  \"workspaceId\": 42,\n  \"agent_id\": \"chat_agent_01hzk4q6dr3n0d4qzpw9z6gth6\",\n  \"from_number\": \"+14155550100\",\n  \"to_number\": \"+14155550199\",\n  \"metadata\": {\n    \"campaign\": \"reactivation\"\n  },\n  \"uponai_dynamic_variables\": {\n    \"customer_first_name\": \"Jamie\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.upon-ai.com/api/chats/outbound-sms")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workspaceId\": 42,\n  \"agent_id\": \"chat_agent_01hzk4q6dr3n0d4qzpw9z6gth6\",\n  \"from_number\": \"+14155550100\",\n  \"to_number\": \"+14155550199\",\n  \"metadata\": {\n    \"campaign\": \"reactivation\"\n  },\n  \"uponai_dynamic_variables\": {\n    \"customer_first_name\": \"Jamie\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.upon-ai.com/api/chats/outbound-sms")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"workspaceId\": 42,\n  \"agent_id\": \"chat_agent_01hzk4q6dr3n0d4qzpw9z6gth6\",\n  \"from_number\": \"+14155550100\",\n  \"to_number\": \"+14155550199\",\n  \"metadata\": {\n    \"campaign\": \"reactivation\"\n  },\n  \"uponai_dynamic_variables\": {\n    \"customer_first_name\": \"Jamie\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "chatId": "<string>",
  "agentId": "<string>",
  "version": 123,
  "status": "<string>",
  "type": "web_chat",
  "metadata": {},
  "customAttributes": {},
  "startedAt": "2023-11-07T05:31:56Z",
  "endedAt": "2023-11-07T05:31:56Z",
  "transcript": "<string>",
  "messages": [
    {
      "content": "<string>",
      "name": "<string>",
      "tool_calls": [
        {}
      ]
    }
  ],
  "chatCost": {},
  "chatAnalysis": {},
  "collectedDynamicVariables": {},
  "uponai_dynamic_variables": {},
  "overrideDynamicVariables": {}
}

Authorizations

Authorization

string

header

required

Generate tokens from your profile settings at app.uponai.com.

Body

application/json

workspaceId

integer

required

agent_id

string

required

from_number

string

required

to_number

string

required

metadata

object

Show child attributes

uponai_dynamic_variables

object

Show child attributes

Response

201 - application/json

Outbound SMS chat created.

chatId

string

agentId

string

version

integer

status

string

type

string

Example:

"web_chat"

metadata

object

Show child attributes

customAttributes

object

Show child attributes

startedAt

string<date-time> | null

endedAt

string<date-time> | null

transcript

string | null

messages

object[]

Show child attributes

chatCost

object | null

chatAnalysis

object | null

collectedDynamicVariables

object

uponai_dynamic_variables

object

Show child attributes

overrideDynamicVariables

object

Show child attributes

Calls

LLM Models

Agents

Chat Agents

Chats

Conversation Flows

Knowledge Bases

Voices

Test Case Definitions

Test Runs

Account

Phone Numbers

Create outbound SMS chat

Authorizations

Body

Response