For a complete page index, fetch https://docs.synthflow.ai/llms.txt. For full documentation content, fetch https://docs.synthflow.ai/llms-full.txt. # Start an outbound chat conversation POST https://api.synthflow.ai/v2/chat/outbound Content-Type: application/json Create a new outbound WhatsApp or SMS conversation for a chat agent. Reference: https://docs.synthflow.ai/api-reference/platform-api/chat/create-outbound-chat ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: Synthflow APIs version: 1.0.0 paths: /chat/outbound: post: operationId: create-outbound-chat summary: Start an outbound chat conversation description: Create a new outbound WhatsApp or SMS conversation for a chat agent. tags: - subpackage_chat parameters: - name: Authorization in: header description: Bearer authentication required: true schema: type: string responses: '200': description: '200' content: application/json: schema: $ref: '#/components/schemas/OutboundChatResponse' '400': description: '400' content: application/json: schema: $ref: >- #/components/schemas/Create-outbound-chatRequestBadRequestError requestBody: content: application/json: schema: $ref: '#/components/schemas/OutboundChatRequest' servers: - url: https://api.synthflow.ai/v2 - url: https://api.us.synthflow.ai/v2 components: schemas: OutboundChatRequestChannel: type: string enum: - sms - whatsapp description: Outbound messaging channel. title: OutboundChatRequestChannel OutboundChatTemplate: type: object properties: content_sid: type: string description: The SID of an approved Twilio Content Template. variables: type: object additionalProperties: description: Any type description: Template variable substitutions keyed by placeholder number. required: - content_sid description: Twilio Content Template to use for outbound WhatsApp delivery. title: OutboundChatTemplate OutboundChatRequest: type: object properties: agent_id: type: string format: uuid description: The ID of the chat agent that will handle the conversation. channel: $ref: '#/components/schemas/OutboundChatRequestChannel' description: Outbound messaging channel. to_number: type: string description: Recipient phone number in E.164 format. from_number: type: string description: Twilio sender phone number in E.164 format. initial_message: type: string description: >- Freeform opening message. For WhatsApp, this is only valid within the 24-hour customer service window. template: $ref: '#/components/schemas/OutboundChatTemplate' description: >- Approved Twilio Content Template for WhatsApp outbound messages. Required outside the 24-hour customer service window, optional within it. custom_variables: type: object additionalProperties: description: Any type description: >- Custom prompt variables to inject into the agent configuration for this conversation. required: - agent_id - channel - to_number - from_number description: Request to start an outbound SMS or WhatsApp chat conversation. title: OutboundChatRequest status: type: string description: Whether the request was successful. title: status OutboundChatResponseResponse: type: object properties: conversation_id: type: string format: uuid description: Unique identifier for the created conversation. required: - conversation_id title: OutboundChatResponseResponse OutboundChatResponse: type: object properties: status: $ref: '#/components/schemas/status' response: $ref: '#/components/schemas/OutboundChatResponseResponse' required: - status - response description: Response returned after an outbound chat conversation is created. title: OutboundChatResponse Create-outbound-chatRequestBadRequestError: type: object properties: {} title: Create-outbound-chatRequestBadRequestError securitySchemes: sec0: type: http scheme: bearer ``` ## SDK Code Examples ```python import requests url = "https://api.synthflow.ai/v2/chat/outbound" payload = { "agent_id": "2a886b7d-d52d-4f8b-8ea0-19d3edc79214", "channel": "whatsapp", "to_number": "+15559876543", "from_number": "+15551234567", "initial_message": "Hi! How can I help you today?" } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.synthflow.ai/v2/chat/outbound" payload := strings.NewReader("{\n \"agent_id\": \"2a886b7d-d52d-4f8b-8ea0-19d3edc79214\",\n \"channel\": \"whatsapp\",\n \"to_number\": \"+15559876543\",\n \"from_number\": \"+15551234567\",\n \"initial_message\": \"Hi! How can I help you today?\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.synthflow.ai/v2/chat/outbound") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"agent_id\": \"2a886b7d-d52d-4f8b-8ea0-19d3edc79214\",\n \"channel\": \"whatsapp\",\n \"to_number\": \"+15559876543\",\n \"from_number\": \"+15551234567\",\n \"initial_message\": \"Hi! How can I help you today?\"\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.synthflow.ai/v2/chat/outbound") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"agent_id\": \"2a886b7d-d52d-4f8b-8ea0-19d3edc79214\",\n \"channel\": \"whatsapp\",\n \"to_number\": \"+15559876543\",\n \"from_number\": \"+15551234567\",\n \"initial_message\": \"Hi! How can I help you today?\"\n}") .asString(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.synthflow.ai/v2/chat/outbound"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"agent_id\": \"2a886b7d-d52d-4f8b-8ea0-19d3edc79214\",\n \"channel\": \"whatsapp\",\n \"to_number\": \"+15559876543\",\n \"from_number\": \"+15551234567\",\n \"initial_message\": \"Hi! How can I help you today?\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "agent_id": "2a886b7d-d52d-4f8b-8ea0-19d3edc79214", "channel": "whatsapp", "to_number": "+15559876543", "from_number": "+15551234567", "initial_message": "Hi! How can I help you today?" ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.synthflow.ai/v2/chat/outbound")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```