Update Agent

cURL

curl --request PUT \
  --url https://api.contactship.ai/v1/agents/{agentId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "person_name": "<string>",
  "voice_id": "<string>",
  "language": "<string>",
  "interruption_sensitivity": 123,
  "webhook_url": "<string>",
  "conversation_purpose": "<string>",
  "prompt": "<string>",
  "voice_speed": 123,
  "voice_temperature": 123,
  "volume": 123,
  "post_call_analysis_data": [
    {}
  ],
  "tools": [
    {}
  ]
}
'

import requests

url = "https://api.contactship.ai/v1/agents/{agentId}"

payload = {
    "name": "<string>",
    "person_name": "<string>",
    "voice_id": "<string>",
    "language": "<string>",
    "interruption_sensitivity": 123,
    "webhook_url": "<string>",
    "conversation_purpose": "<string>",
    "prompt": "<string>",
    "voice_speed": 123,
    "voice_temperature": 123,
    "volume": 123,
    "post_call_analysis_data": [{}],
    "tools": [{}]
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    person_name: '<string>',
    voice_id: '<string>',
    language: '<string>',
    interruption_sensitivity: 123,
    webhook_url: '<string>',
    conversation_purpose: '<string>',
    prompt: '<string>',
    voice_speed: 123,
    voice_temperature: 123,
    volume: 123,
    post_call_analysis_data: [{}],
    tools: [{}]
  })
};

fetch('https://api.contactship.ai/v1/agents/{agentId}', 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.contactship.ai/v1/agents/{agentId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'person_name' => '<string>',
    'voice_id' => '<string>',
    'language' => '<string>',
    'interruption_sensitivity' => 123,
    'webhook_url' => '<string>',
    'conversation_purpose' => '<string>',
    'prompt' => '<string>',
    'voice_speed' => 123,
    'voice_temperature' => 123,
    'volume' => 123,
    'post_call_analysis_data' => [
        [
                
        ]
    ],
    'tools' => [
        [
                
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$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.contactship.ai/v1/agents/{agentId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"person_name\": \"<string>\",\n  \"voice_id\": \"<string>\",\n  \"language\": \"<string>\",\n  \"interruption_sensitivity\": 123,\n  \"webhook_url\": \"<string>\",\n  \"conversation_purpose\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"voice_speed\": 123,\n  \"voice_temperature\": 123,\n  \"volume\": 123,\n  \"post_call_analysis_data\": [\n    {}\n  ],\n  \"tools\": [\n    {}\n  ]\n}")

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

	req.Header.Add("x-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.put("https://api.contactship.ai/v1/agents/{agentId}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"person_name\": \"<string>\",\n  \"voice_id\": \"<string>\",\n  \"language\": \"<string>\",\n  \"interruption_sensitivity\": 123,\n  \"webhook_url\": \"<string>\",\n  \"conversation_purpose\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"voice_speed\": 123,\n  \"voice_temperature\": 123,\n  \"volume\": 123,\n  \"post_call_analysis_data\": [\n    {}\n  ],\n  \"tools\": [\n    {}\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.contactship.ai/v1/agents/{agentId}")

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

request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"person_name\": \"<string>\",\n  \"voice_id\": \"<string>\",\n  \"language\": \"<string>\",\n  \"interruption_sensitivity\": 123,\n  \"webhook_url\": \"<string>\",\n  \"conversation_purpose\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"voice_speed\": 123,\n  \"voice_temperature\": 123,\n  \"volume\": 123,\n  \"post_call_analysis_data\": [\n    {}\n  ],\n  \"tools\": [\n    {}\n  ]\n}"

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

{
  "statusCode": 200,
  "data": {
    "id": "337a9eeb-3e16-4cc5-94ec-25fa159eb57a",
    "name": "Technical Support Specialist",
    "person_name": "Emily Parker",
    "language": "en-US",
    "webhook_url": "https://webhook.example.com/support-notifications",
    "conversation_purpose": "Provide technical support and troubleshooting assistance to customers",
    "prompt": "You are Emily Parker, an experienced technical support specialist. Your role is to help customers resolve technical issues efficiently and professionally.\n\nGuidelines:\n- Start by understanding the customer's issue clearly\n- Provide step-by-step solutions in a clear, natural way\n- Use simple language, avoiding technical jargon unless necessary\n- Create support tickets for complex issues\n- Follow up to ensure the solution worked\n\nMaintain a patient and helpful tone throughout the conversation.",
    "volume": 1.1,
    "voice_id": "custom_voice_emily_tech",
    "interruption_sensitivity": 0.7,
    "ambient_sound": "call-center",
    "voice_speed": 1,
    "voice_temperature": 0.8,
    "post_call_analysis_data": [
      {
        "name": "issue_resolved",
        "type": "boolean",
        "description": "Whether the technical issue was resolved"
      },
      {
        "name": "resolution_time",
        "type": "number",
        "description": "Time taken to resolve the issue (minutes)"
      },
      {
        "name": "ticket_created",
        "type": "boolean",
        "description": "Whether a support ticket was created"
      },
      {
        "name": "customer_satisfaction",
        "type": "number",
        "description": "Customer satisfaction score (1-10)"
      }
    ],
    "tools": [
      {
        "name": "create_ticket",
        "type": "function",
        "description": "Create a support ticket for unresolved issues"
      },
      {
        "name": "search_knowledge_base",
        "type": "function",
        "description": "Search technical documentation for solutions",
        "parameters": {
          "type": "object",
          "required": [
            "query"
          ],
          "properties": {
            "query": {
              "type": "string",
              "description": "Search query for technical documentation"
            }
          }
        }
      },
      {
        "name": "schedule_followup",
        "type": "function",
        "description": "Schedule a follow-up call for complex issues"
      }
    ],
    "created_at": "2024-01-15T10:30:00.000Z",
    "updated_at": "2024-03-20T15:45:00.000Z"
  }
}

{
  "error": 123,
  "message": "<string>"
}

PUT

agents

{agentId}

cURL

curl --request PUT \
  --url https://api.contactship.ai/v1/agents/{agentId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "person_name": "<string>",
  "voice_id": "<string>",
  "language": "<string>",
  "interruption_sensitivity": 123,
  "webhook_url": "<string>",
  "conversation_purpose": "<string>",
  "prompt": "<string>",
  "voice_speed": 123,
  "voice_temperature": 123,
  "volume": 123,
  "post_call_analysis_data": [
    {}
  ],
  "tools": [
    {}
  ]
}
'

import requests

url = "https://api.contactship.ai/v1/agents/{agentId}"

payload = {
    "name": "<string>",
    "person_name": "<string>",
    "voice_id": "<string>",
    "language": "<string>",
    "interruption_sensitivity": 123,
    "webhook_url": "<string>",
    "conversation_purpose": "<string>",
    "prompt": "<string>",
    "voice_speed": 123,
    "voice_temperature": 123,
    "volume": 123,
    "post_call_analysis_data": [{}],
    "tools": [{}]
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    person_name: '<string>',
    voice_id: '<string>',
    language: '<string>',
    interruption_sensitivity: 123,
    webhook_url: '<string>',
    conversation_purpose: '<string>',
    prompt: '<string>',
    voice_speed: 123,
    voice_temperature: 123,
    volume: 123,
    post_call_analysis_data: [{}],
    tools: [{}]
  })
};

fetch('https://api.contactship.ai/v1/agents/{agentId}', 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.contactship.ai/v1/agents/{agentId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'person_name' => '<string>',
    'voice_id' => '<string>',
    'language' => '<string>',
    'interruption_sensitivity' => 123,
    'webhook_url' => '<string>',
    'conversation_purpose' => '<string>',
    'prompt' => '<string>',
    'voice_speed' => 123,
    'voice_temperature' => 123,
    'volume' => 123,
    'post_call_analysis_data' => [
        [
                
        ]
    ],
    'tools' => [
        [
                
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$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.contactship.ai/v1/agents/{agentId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"person_name\": \"<string>\",\n  \"voice_id\": \"<string>\",\n  \"language\": \"<string>\",\n  \"interruption_sensitivity\": 123,\n  \"webhook_url\": \"<string>\",\n  \"conversation_purpose\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"voice_speed\": 123,\n  \"voice_temperature\": 123,\n  \"volume\": 123,\n  \"post_call_analysis_data\": [\n    {}\n  ],\n  \"tools\": [\n    {}\n  ]\n}")

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

	req.Header.Add("x-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.put("https://api.contactship.ai/v1/agents/{agentId}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"person_name\": \"<string>\",\n  \"voice_id\": \"<string>\",\n  \"language\": \"<string>\",\n  \"interruption_sensitivity\": 123,\n  \"webhook_url\": \"<string>\",\n  \"conversation_purpose\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"voice_speed\": 123,\n  \"voice_temperature\": 123,\n  \"volume\": 123,\n  \"post_call_analysis_data\": [\n    {}\n  ],\n  \"tools\": [\n    {}\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.contactship.ai/v1/agents/{agentId}")

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

request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"person_name\": \"<string>\",\n  \"voice_id\": \"<string>\",\n  \"language\": \"<string>\",\n  \"interruption_sensitivity\": 123,\n  \"webhook_url\": \"<string>\",\n  \"conversation_purpose\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"voice_speed\": 123,\n  \"voice_temperature\": 123,\n  \"volume\": 123,\n  \"post_call_analysis_data\": [\n    {}\n  ],\n  \"tools\": [\n    {}\n  ]\n}"

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

{
  "statusCode": 200,
  "data": {
    "id": "337a9eeb-3e16-4cc5-94ec-25fa159eb57a",
    "name": "Technical Support Specialist",
    "person_name": "Emily Parker",
    "language": "en-US",
    "webhook_url": "https://webhook.example.com/support-notifications",
    "conversation_purpose": "Provide technical support and troubleshooting assistance to customers",
    "prompt": "You are Emily Parker, an experienced technical support specialist. Your role is to help customers resolve technical issues efficiently and professionally.\n\nGuidelines:\n- Start by understanding the customer's issue clearly\n- Provide step-by-step solutions in a clear, natural way\n- Use simple language, avoiding technical jargon unless necessary\n- Create support tickets for complex issues\n- Follow up to ensure the solution worked\n\nMaintain a patient and helpful tone throughout the conversation.",
    "volume": 1.1,
    "voice_id": "custom_voice_emily_tech",
    "interruption_sensitivity": 0.7,
    "ambient_sound": "call-center",
    "voice_speed": 1,
    "voice_temperature": 0.8,
    "post_call_analysis_data": [
      {
        "name": "issue_resolved",
        "type": "boolean",
        "description": "Whether the technical issue was resolved"
      },
      {
        "name": "resolution_time",
        "type": "number",
        "description": "Time taken to resolve the issue (minutes)"
      },
      {
        "name": "ticket_created",
        "type": "boolean",
        "description": "Whether a support ticket was created"
      },
      {
        "name": "customer_satisfaction",
        "type": "number",
        "description": "Customer satisfaction score (1-10)"
      }
    ],
    "tools": [
      {
        "name": "create_ticket",
        "type": "function",
        "description": "Create a support ticket for unresolved issues"
      },
      {
        "name": "search_knowledge_base",
        "type": "function",
        "description": "Search technical documentation for solutions",
        "parameters": {
          "type": "object",
          "required": [
            "query"
          ],
          "properties": {
            "query": {
              "type": "string",
              "description": "Search query for technical documentation"
            }
          }
        }
      },
      {
        "name": "schedule_followup",
        "type": "function",
        "description": "Schedule a follow-up call for complex issues"
      }
    ],
    "created_at": "2024-01-15T10:30:00.000Z",
    "updated_at": "2024-03-20T15:45:00.000Z"
  }
}

{
  "error": 123,
  "message": "<string>"
}

Autorizaciones

x-api-key

string

header

requerido

Encabezados

x-api-key

string

requerido

API key for authentication

Parámetros de ruta

agentId

string

requerido

The ID of the agent to update

Cuerpo

application/json

Update agent configuration

name

string

The name of the agent in our system. Only used for your own reference.

person_name

string

The name of the agent in the call.

voice_id

string

The ID of the voice to use [Still working on this]

language

string

Specifies what language (and dialect) the speech recognition will operate in. For instance, selecting en-GB optimizes speech recognition for British English. If unset, will use default value en-US. Select multi for multilingual support, currently this supports Spanish and English.

Available options: en-US, en-IN, en-GB, de-DE, es-ES, es-419, hi-IN, ja-JP, pt-PT, pt-BR, fr-FR, zh-CN, ru-RU, it-IT, ko-KR, nl-NL, pl-PL, tr-TR, vi-VN, multi

ambient_sound

enum<string> | null

If set, will add ambient environment sound to the call to make experience more realistic. Currently supports the following options:

coffee-shop: Coffee shop ambience with people chatting in background. Listen to Ambience
convention-hall: Convention hall ambience, with some echo and people chatting in background. Listen to Ambience
summer-outdoor: Summer outdoor ambience with cicada chirping. Listen to Ambience
mountain-outdoor: Mountain outdoor ambience with birds singing. Listen to Ambience
static-noise: Constant static noise. Listen to Ambience
call-center: Call center work noise. Listen to Ambience

Set to null to remove ambient sound from this agent.

Available options: coffee-shop, convention-hall, summer-outdoor, mountain-outdoor, static-noise, call-center

Opciones disponibles:

coffee-shop,

convention-hall,

summer-outdoor,

mountain-outdoor,

static-noise,

call-center,

null

interruption_sensitivity

number

Controls how sensitive the agent is to user interruptions. Value ranging from [0.1,1]. Lower value means it will take longer / more words for user to interrupt agent, while higher value means it's easier for user to interrupt agent.

If unset, default value 1 will apply. When this is set to 0.1, agent would never be interrupted.

webhook_url

string

URL for webhook notifications. They will be sent when the agent finishes a call, from API calls, Inbound calls, Campaigns calls or Widgets calls.

conversation_purpose

string

The purpose of conversations for this agent

prompt

string

The prompt template for the agent

voice_speed

number

Controls speed of voice. Value ranging from [0.5,2]. Lower value means slower speech, while higher value means faster speech rate. If unset, default value 1 will apply.

voice_temperature

number

Controls how stable the voice is. Value ranging from [0,2]. Lower value means more stable, and higher value means more variant speech generation. If unset, default value 1 will apply.

volume

number

If set, will control the volume of the agent. Value ranging from [0,2]. Lower value means quieter agent speech, while higher value means louder agent speech. If unset, default value 1 will apply.

post_call_analysis_data

(object | null)[]

Configuration for post-call analysis

tools

(object | null)[]

List of tools available to the agent

Respuesta

Agent updated successfully

statusCode

integer

HTTP status code

data

object

Show child attributes

Documentación API

Voz

WhatsApp (WABA)

Canales y Conversaciones

Organización

Agentes

Contactos

Etiquetas

Llamadas

Números de Teléfono

Autorizaciones

Encabezados

Parámetros de ruta

Cuerpo

Respuesta