Update Dialer

cURL

curl --request PUT \
  --url 'https://api.precallai.com/api/v1/dialer/update?id={id}' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "dialer_type": "Twilio",
  "name": "<string>",
  "phone_number": "<string>",
  "sid": "<string>",
  "auth_token": "<string>",
  "sip_termination_uri": "<string>",
  "sip_trunk_user_name": "<string>",
  "sip_trunk_password": "<string>"
}'

{
  "type": "inbound",
  "language": "en",
  "name": "<string>",
  "company_name": "<string>",
  "accent": "<string>",
  "actions": [
    {
      "type": "scheduleMeeting",
      "meetingType": "openBooking",
      "timezone": "<string>",
      "startDate": "<string>",
      "description": "<string>",
      "say": "<string>",
      "length": 123,
      "prompt": "<string>",
      "startTime": "<string>",
      "endTime": "<string>",
      "bookingDays": "<string>"
    }
  ],
  "goal": "<string>",
  "start_speech": "<string>",
  "voice_id": "<string>",
  "voice_name": "<string>",
  "zapier_hook": "<string>",
  "script": "<string>",
  "knowledge_base_Id": "<string>",
  "maximum_time_per_call": 123,
  "is_recording": true,
  "is_voice_note": true,
  "voice_note": "<string>",
  "ai_model_id": "<string>",
  "sentiment": {
    "general_prompt": "<string>",
    "positive_prompt": "<string>",
    "negative_prompt": "<string>",
    "neutral_prompt": "<string>"
  },
  "is_back_sound": true,
  "voice_speed": 1,
  "is_filler": true,
  "fillers": [
    "<any>"
  ],
  "assistant_image": "https://precallai.s3.ap-south-1.amazonaws.com/assistant_profile/1.jpeg",
  "ai_modal": "<string>",
  "is_sensitivity": true,
  "sensitivity": 600,
  "temperature": 0.7,
  "is_opt_out": true,
  "opt_out_script": "If a user explicitly expresses that they no longer wish to receive calls, such as by saying 'Don't call me again,' 'I'm not interested,' or any similar phrase indicating that they want to opt out of future communications, please trigger the 'optOut' function and inform the user that they will no longer be contacted for calls.",
  "is_wait_start_speech": true,
  "utterance_length": 1,
  "meeting_note_prompt": "<string>",
  "call_outcome_prompt": "<string>"
}

PUT

dialer

update?id=

{id}

cURL

curl --request PUT \
  --url 'https://api.precallai.com/api/v1/dialer/update?id={id}' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "dialer_type": "Twilio",
  "name": "<string>",
  "phone_number": "<string>",
  "sid": "<string>",
  "auth_token": "<string>",
  "sip_termination_uri": "<string>",
  "sip_trunk_user_name": "<string>",
  "sip_trunk_password": "<string>"
}'

{
  "type": "inbound",
  "language": "en",
  "name": "<string>",
  "company_name": "<string>",
  "accent": "<string>",
  "actions": [
    {
      "type": "scheduleMeeting",
      "meetingType": "openBooking",
      "timezone": "<string>",
      "startDate": "<string>",
      "description": "<string>",
      "say": "<string>",
      "length": 123,
      "prompt": "<string>",
      "startTime": "<string>",
      "endTime": "<string>",
      "bookingDays": "<string>"
    }
  ],
  "goal": "<string>",
  "start_speech": "<string>",
  "voice_id": "<string>",
  "voice_name": "<string>",
  "zapier_hook": "<string>",
  "script": "<string>",
  "knowledge_base_Id": "<string>",
  "maximum_time_per_call": 123,
  "is_recording": true,
  "is_voice_note": true,
  "voice_note": "<string>",
  "ai_model_id": "<string>",
  "sentiment": {
    "general_prompt": "<string>",
    "positive_prompt": "<string>",
    "negative_prompt": "<string>",
    "neutral_prompt": "<string>"
  },
  "is_back_sound": true,
  "voice_speed": 1,
  "is_filler": true,
  "fillers": [
    "<any>"
  ],
  "assistant_image": "https://precallai.s3.ap-south-1.amazonaws.com/assistant_profile/1.jpeg",
  "ai_modal": "<string>",
  "is_sensitivity": true,
  "sensitivity": 600,
  "temperature": 0.7,
  "is_opt_out": true,
  "opt_out_script": "If a user explicitly expresses that they no longer wish to receive calls, such as by saying 'Don't call me again,' 'I'm not interested,' or any similar phrase indicating that they want to opt out of future communications, please trigger the 'optOut' function and inform the user that they will no longer be contacted for calls.",
  "is_wait_start_speech": true,
  "utterance_length": 1,
  "meeting_note_prompt": "<string>",
  "call_outcome_prompt": "<string>"
}

Authorizations

x-api-key

string

header

required

Path Parameters

string

required

The ID of the dialer to update

Body

application/json

Dialer to update

dialer_type

enum<string>

required

Dialer type

Available options:

Twilio,

Telnyx,

sip

name

string

required

The name of the dialer

phone_number

string

required

Phone number

sid

string

required

The sid

auth_token

string

required

Auth token and also for Telnyx id not require.

sip_termination_uri

string

required

SIP termination uri for only sip

sip_trunk_user_name

string

SIP trunk user name for only sip

sip_trunk_password

string

SIP trunk password for only sip

Response

Dialer response

type

enum<string>

required

Type of assistant

Available options:

inbound,

outbound

language

enum<string>

required

Language of the assistant. Supported values: en (English), de (German), hi (Hindi), es (Spanish), fr (French), it (Italian), ar-kw (Arabic Kuwait), gu (Gujarati), bn (Bengali), te (Telugu India), kn (Kannada India), ta (Tamil India), mr (Marathi).

Available options:

en,

de,

hi,

es,

fr,

it,

ar-kw,

gu,

bn,

te,

kn,

ta,

mr

name

string

required

The name of the assistant

company_name

string

required

The name of the company

accent

string

required

The accent

goal

string

required

The goal of the assistant

start_speech

string

required

Start speech of the assistant

voice_id

string

required

Voice Id will get where we choose Accent

voice_name

string

required

Voice name will get where we choose Accent

script

string

required

Script of the assistant

maximum_time_per_call

number

required

Maximum time per call in minutes

is_voice_note

boolean

required

Enable disable voice note

voice_note

string

required

Voice note is required if is_voice_note are enabled.

ai_model_id

string

required

AI model id need to pass.

sentiment

object

required

Sentiment classification prompts for analyzing conversations.

Show child attributes

voice_speed

enum<number>

required

Voice speed sound enable/disable

Available options:

1,

1.1,

1.2,

1.3,

1.4,

1.5,

1.6,

1.7,

1.8,

1.9,

2

is_filler

boolean

required

Filler enable/disable

fillers

any[]

required

Fillers

assistant_image

enum<string>

required

Assistant image url

Available options:

https://precallai.s3.ap-south-1.amazonaws.com/assistant_profile/1.jpeg,

https://precallai.s3.ap-south-1.amazonaws.com/assistant_profile/3.jpeg,

https://precallai.s3.ap-south-1.amazonaws.com/assistant_profile/4.jpeg,

https://precallai.s3.ap-south-1.amazonaws.com/assistant_profile/5.jpeg

AI modal will get where we choose Accent

sensitivity

enum<number>

required

Sensitivity

Available options:

600,

700,

800,

900,

1000,

1100,

1200,

1300,

1400,

1500,

1600,

1700,

1800,

1900,

2000

temperature

enum<number>

required

Temperature

Available options:

0.7,

0.8,

0.9,

1,

1.1,

1.2,

1.3,

1.4,

1.5,

1.6,

1.7,

1.8,

1.9,

2

opt_out_script

enum<string>

required

If is_opt_out is enable then add opt out prompts

Available options:

If a user explicitly expresses that they no longer wish to receive calls, such as by saying 'Don't call me again,' 'I'm not interested,' or any similar phrase indicating that they want to opt out of future communications, please trigger the 'optOut' function and inform the user that they will no longer be contacted for calls.

is_wait_start_speech

boolean

required

For assistant typle is outbound then you can enable or disable

utterance_length

enum<number>

required

Utterance length

Available options:

1,

2,

3,

4,

5,

6,

7,

8,

9,

10

meeting_note_prompt

string

required

Meeting note prompt

call_outcome_prompt

string

required

Call outcome prompt

actions

object[]

The actions

Show child attributes

zapier_hook

string

For Zapier hook need to add link

knowledge_base_Id

string

Knowledge base

is_recording

boolean

Enable disable recording

is_back_sound

boolean

Background sound enable/disable

is_sensitivity

boolean

Sensitivity enable/disable

is_opt_out

boolean

Opt out enable/disable

Create Dialer Delete Dialer

Authorization

Assistants

Playground

Dialers

Segments

Campaigns

Authorizations

Path Parameters

Body

Response