Getting Error in POST request

sacred-emerald · 2024-05-17T07:51:30.118Z

error in POST request while testing in postman { "message": [ "property customer should not exist", "property phoneNumberId should not exist", "property phoneNumber should not exist", "property assistantOverride should not exist" ], "error": "Bad Request", "statusCode": 400 }

A

Ask Inkeep•5/17/24, 7:51 AM

Hi @AI, I'm an AI assistant for Vapi. I'll analyze available sources and get back to you shortly.

A

Ask Inkeep•5/17/24, 7:51 AM

-----------------------------
While I generate an answer, here are some sources that might be helpful:

Create Phone Call
Server Events
Get Call
List Calls
-----------------------------

A

Ask Inkeep•5/17/24, 7:51 AM

Answer

The error message you're encountering indicates that there are some properties in your POST request that are not recognized or are not expected by the Vapi API endpoint you're targeting.

This typically means that the structure of your JSON payload does not match what the API expects. You should review the API documentation for the specific endpoint you're working with to ensure that your JSON payload includes only the expected properties and that they are correctly formatted.

For example, if you are making a call to create a phone call, ensure that your payload aligns with the documented parameters. Here's a reference on how to structure a request for creating a phone call under Vapi's API, which requires specific fields such as

assistantId

assistantId

assistantId

assistantId, and

customer

customer

customer

customer with nested

number

number

number

number information (1) .

Make sure to consult the official API reference to match your request body with the expected schema.

Sources
[1] Create Phone Call

S

sacred-emeraldOP•5/17/24, 7:52 AM

provide me the right schema

S

sacred-emeraldOP•5/17/24, 7:52 AM

@Ask Inkeep

A

Ask Inkeep•5/17/24, 7:52 AM

Hmm.. Seems like I didn't receive a question. Please start a new thread with your question.

S

sacred-emeraldOP•5/17/24, 7:53 AM

provide the right schema for create phone call @Ask Inkeep

A

Ask Inkeep•5/17/24, 7:53 AM

Thanks for the follow-up, @AI. I'll get back to you soon.

A

Ask Inkeep•5/17/24, 7:53 AM

-----------------------------
While I generate an answer, here are some sources that might be helpful:

Create Phone Call
Get Call
List Calls
Update Phone Number
-----------------------------

A

Ask Inkeep•5/17/24, 7:54 AM

Answer

To create a phone call using Vapi, you need to send a POST request with a JSON payload structured as follows:

A

Ask Inkeep•5/17/24, 7:54 AM

{
  "maxDurationSeconds": 1800,
  "customerId": "<string>",
  "customer": {
    "number": "<string>",
    "name": "<string>",
    "extension": "<string>"
  },
  "phoneNumberId": "<string>",
  "phoneNumber": {
    "twilioPhoneNumber": "<string>",
    "twilioAccountSid": "<string>",
    "twilioAuthToken": "<string>",
    "name": "<string>",
    "assistantId": "<string>",
    "serverUrl": "<string>",
    "serverUrlSecret": "<string>"
  },
  "metadata": {},
  "assistantId": "<string>",
  "assistantOverride": {
    "transcriber": {
      "provider": "deepgram",
      "model": "nova-2",
      "language": "cs",
      "smartFormat": true,
      "keywords": [
        "<string>"
      ]
    },
    "model": {
      "messages": [
        {
          "content": "<string>",
          "role": "assistant",
          "function_call": {},
          "tool_calls": [
            {}
          ],
          "tool_call_id": "<string>"
        }
      ],
      "tools": [
        {
          "type": "transferCall",
          "messages": [
            {
              "type": "request-start",
              "content": "<string>",
              "conditions": [
                {
                  "param": "<string>",
                  "value": {},
                  "operator": "eq"
                }
              ]
            }
          ],
          "destinations": [
            {}
          ],
          "server": {
            "url": "<string>",
            "secret": "<string>"
          },
          "function": {
            "name": "<string>",
            "description": "<string>",
            "parameters": {
              "type": "object",
              "properties": {},
              "required": [
                "<string>"
              ]
            }
          }
        }
      ],
      "provider": "openai",
      "model": "gpt-4o",
      "fallbackModels": [
        "gpt-4-0125-

{
  "maxDurationSeconds": 1800,
  "customerId": "<string>",
  "customer": {
    "number": "<string>",
    "name": "<string>",
    "extension": "<string>"
  },
  "phoneNumberId": "<string>",
  "phoneNumber": {
    "twilioPhoneNumber": "<string>",
    "twilioAccountSid": "<string>",
    "twilioAuthToken": "<string>",
    "name": "<string>",
    "assistantId": "<string>",
    "serverUrl": "<string>",
    "serverUrlSecret": "<string>"
  },
  "metadata": {},
  "assistantId": "<string>",
  "assistantOverride": {
    "transcriber": {
      "provider": "deepgram",
      "model": "nova-2",
      "language": "cs",
      "smartFormat": true,
      "keywords": [
        "<string>"
      ]
    },
    "model": {
      "messages": [
        {
          "content": "<string>",
          "role": "assistant",
          "function_call": {},
          "tool_calls": [
            {}
          ],
          "tool_call_id": "<string>"
        }
      ],
      "tools": [
        {
          "type": "transferCall",
          "messages": [
            {
              "type": "request-start",
              "content": "<string>",
              "conditions": [
                {
                  "param": "<string>",
                  "value": {},
                  "operator": "eq"
                }
              ]
            }
          ],
          "destinations": [
            {}
          ],
          "server": {
            "url": "<string>",
            "secret": "<string>"
          },
          "function": {
            "name": "<string>",
            "description": "<string>",
            "parameters": {
              "type": "object",
              "properties": {},
              "required": [
                "<string>"
              ]
            }
          }
        }
      ],
      "provider": "openai",
      "model": "gpt-4o",
      "fallbackModels": [
        "gpt-4-0125-

{
  "maxDurationSeconds": 1800,
  "customerId": "<string>",
  "customer": {
    "number": "<string>",
    "name": "<string>",
    "extension": "<string>"
  },
  "phoneNumberId": "<string>",
  "phoneNumber": {
    "twilioPhoneNumber": "<string>",
    "twilioAccountSid": "<string>",
    "twilioAuthToken": "<string>",
    "name": "<string>",
    "assistantId": "<string>",
    "serverUrl": "<string>",
    "serverUrlSecret": "<string>"
  },
  "metadata": {},
  "assistantId": "<string>",
  "assistantOverride": {
    "transcriber": {
      "provider": "deepgram",
      "model": "nova-2",
      "language": "cs",
      "smartFormat": true,
      "keywords": [
        "<string>"
      ]
    },
    "model": {
      "messages": [
        {
          "content": "<string>",
          "role": "assistant",
          "function_call": {},
          "tool_calls": [
            {}
          ],
          "tool_call_id": "<string>"
        }
      ],
      "tools": [
        {
          "type": "transferCall",
          "messages": [
            {
              "type": "request-start",
              "content": "<string>",
              "conditions": [
                {
                  "param": "<string>",
                  "value": {},
                  "operator": "eq"
                }
              ]
            }
          ],
          "destinations": [
            {}
          ],
          "server": {
            "url": "<string>",
            "secret": "<string>"
          },
          "function": {
            "name": "<string>",
            "description": "<string>",
            "parameters": {
              "type": "object",
              "properties": {},
              "required": [
                "<string>"
              ]
            }
          }
        }
      ],
      "provider": "openai",
      "model": "gpt-4o",
      "fallbackModels": [
        "gpt-4-0125-

{
  "maxDurationSeconds": 1800,
  "customerId": "<string>",
  "customer": {
    "number": "<string>",
    "name": "<string>",
    "extension": "<string>"
  },
  "phoneNumberId": "<string>",
  "phoneNumber": {
    "twilioPhoneNumber": "<string>",
    "twilioAccountSid": "<string>",
    "twilioAuthToken": "<string>",
    "name": "<string>",
    "assistantId": "<string>",
    "serverUrl": "<string>",
    "serverUrlSecret": "<string>"
  },
  "metadata": {},
  "assistantId": "<string>",
  "assistantOverride": {
    "transcriber": {
      "provider": "deepgram",
      "model": "nova-2",
      "language": "cs",
      "smartFormat": true,
      "keywords": [
        "<string>"
      ]
    },
    "model": {
      "messages": [
        {
          "content": "<string>",
          "role": "assistant",
          "function_call": {},
          "tool_calls": [
            {}
          ],
          "tool_call_id": "<string>"
        }
      ],
      "tools": [
        {
          "type": "transferCall",
          "messages": [
            {
              "type": "request-start",
              "content": "<string>",
              "conditions": [
                {
                  "param": "<string>",
                  "value": {},
                  "operator": "eq"
                }
              ]
            }
          ],
          "destinations": [
            {}
          ],
          "server": {
            "url": "<string>",
            "secret": "<string>"
          },
          "function": {
            "name": "<string>",
            "description": "<string>",
            "parameters": {
              "type": "object",
              "properties": {},
              "required": [
                "<string>"
              ]
            }
          }
        }
      ],
      "provider": "openai",
      "model": "gpt-4o",
      "fallbackModels": [
        "gpt-4-0125-

A

Ask Inkeep•5/17/24, 7:54 AM

preview",
        "gpt-4-0613"
      ],
      "semanticCachingEnabled": true,
      "numFastTurns": 1,
      "temperature": 1,
      "knowledgeBase": {
        "topK": 123,
        "fileIds": [
          "<string>"
        ],
        "provider": "canonical"
      },
      "maxTokens": 525,
      "emotionRecognitionEnabled": true
    },
    "voice": {
      "inputMinCharacters": 10,
      "inputPunctuationBoundaries": [
        "。",
        "，",
        ".",
        "!",
        "?",
        ";",
        ")",
        "،",
        "۔",
        "।",
        "॥",
        "|",
        "||",
        ",",
        ":"
      ],
      "fillerInjectionEnabled": true,
      "provider": "azure",
      "voiceId": "andrew",
      "speed": 1.25
    },
    "forwardingPhoneNumber": "<string>",
    "firstMessageMode": "assistant-speaks-first",
    "voicemailDetectionTypes": [
      "machine_end_beep",
      "machine_end_silence",
      "machine_end_other"
    ],
    "recordingEnabled": true,
    "endCallFunctionEnabled": true,
    "dialKeypadFunctionEnabled": true,
    "hipaaEnabled": true,
    "clientMessages": [
      "transcript",
      "hang",
      "tool-calls",
      "speech-update",
      "metadata",
      "conversation-update"
    ],
    "serverMessages": [
      "end-of-call-report",
      "status-update",
      "hang",
      "tool-calls"
    ],
    "silenceTimeoutSeconds": 30,
    "responseDelaySeconds": 0.4,
    "llmRequestDelaySeconds": 0.1,
    "numWordsToInterruptAssistant": 1,
    "maxDurationSeconds": 1800,
    "backgroundSound": "office",
    "backchannelingEnabled": true,
    "variableValues": {},
    "name": "<string>",
    "firstMessage": "<string>",
    "voicemailDetectionEnabled": true,
    "voicemailMessage": "<string>",
    "endCallMessage": "<string>",
    "endCallPhrases": [
      "<string>"
    ],
    "metadata": {},
    "serverUrl": "<string>",
    "ser

preview",
        "gpt-4-0613"
      ],
      "semanticCachingEnabled": true,
      "numFastTurns": 1,
      "temperature": 1,
      "knowledgeBase": {
        "topK": 123,
        "fileIds": [
          "<string>"
        ],
        "provider": "canonical"
      },
      "maxTokens": 525,
      "emotionRecognitionEnabled": true
    },
    "voice": {
      "inputMinCharacters": 10,
      "inputPunctuationBoundaries": [
        "。",
        "，",
        ".",
        "!",
        "?",
        ";",
        ")",
        "،",
        "۔",
        "।",
        "॥",
        "|",
        "||",
        ",",
        ":"
      ],
      "fillerInjectionEnabled": true,
      "provider": "azure",
      "voiceId": "andrew",
      "speed": 1.25
    },
    "forwardingPhoneNumber": "<string>",
    "firstMessageMode": "assistant-speaks-first",
    "voicemailDetectionTypes": [
      "machine_end_beep",
      "machine_end_silence",
      "machine_end_other"
    ],
    "recordingEnabled": true,
    "endCallFunctionEnabled": true,
    "dialKeypadFunctionEnabled": true,
    "hipaaEnabled": true,
    "clientMessages": [
      "transcript",
      "hang",
      "tool-calls",
      "speech-update",
      "metadata",
      "conversation-update"
    ],
    "serverMessages": [
      "end-of-call-report",
      "status-update",
      "hang",
      "tool-calls"
    ],
    "silenceTimeoutSeconds": 30,
    "responseDelaySeconds": 0.4,
    "llmRequestDelaySeconds": 0.1,
    "numWordsToInterruptAssistant": 1,
    "maxDurationSeconds": 1800,
    "backgroundSound": "office",
    "backchannelingEnabled": true,
    "variableValues": {},
    "name": "<string>",
    "firstMessage": "<string>",
    "voicemailDetectionEnabled": true,
    "voicemailMessage": "<string>",
    "endCallMessage": "<string>",
    "endCallPhrases": [
      "<string>"
    ],
    "metadata": {},
    "serverUrl": "<string>",
    "ser

preview",
        "gpt-4-0613"
      ],
      "semanticCachingEnabled": true,
      "numFastTurns": 1,
      "temperature": 1,
      "knowledgeBase": {
        "topK": 123,
        "fileIds": [
          "<string>"
        ],
        "provider": "canonical"
      },
      "maxTokens": 525,
      "emotionRecognitionEnabled": true
    },
    "voice": {
      "inputMinCharacters": 10,
      "inputPunctuationBoundaries": [
        "。",
        "，",
        ".",
        "!",
        "?",
        ";",
        ")",
        "،",
        "۔",
        "।",
        "॥",
        "|",
        "||",
        ",",
        ":"
      ],
      "fillerInjectionEnabled": true,
      "provider": "azure",
      "voiceId": "andrew",
      "speed": 1.25
    },
    "forwardingPhoneNumber": "<string>",
    "firstMessageMode": "assistant-speaks-first",
    "voicemailDetectionTypes": [
      "machine_end_beep",
      "machine_end_silence",
      "machine_end_other"
    ],
    "recordingEnabled": true,
    "endCallFunctionEnabled": true,
    "dialKeypadFunctionEnabled": true,
    "hipaaEnabled": true,
    "clientMessages": [
      "transcript",
      "hang",
      "tool-calls",
      "speech-update",
      "metadata",
      "conversation-update"
    ],
    "serverMessages": [
      "end-of-call-report",
      "status-update",
      "hang",
      "tool-calls"
    ],
    "silenceTimeoutSeconds": 30,
    "responseDelaySeconds": 0.4,
    "llmRequestDelaySeconds": 0.1,
    "numWordsToInterruptAssistant": 1,
    "maxDurationSeconds": 1800,
    "backgroundSound": "office",
    "backchannelingEnabled": true,
    "variableValues": {},
    "name": "<string>",
    "firstMessage": "<string>",
    "voicemailDetectionEnabled": true,
    "voicemailMessage": "<string>",
    "endCallMessage": "<string>",
    "endCallPhrases": [
      "<string>"
    ],
    "metadata": {},
    "serverUrl": "<string>",
    "ser

preview",
        "gpt-4-0613"
      ],
      "semanticCachingEnabled": true,
      "numFastTurns": 1,
      "temperature": 1,
      "knowledgeBase": {
        "topK": 123,
        "fileIds": [
          "<string>"
        ],
        "provider": "canonical"
      },
      "maxTokens": 525,
      "emotionRecognitionEnabled": true
    },
    "voice": {
      "inputMinCharacters": 10,
      "inputPunctuationBoundaries": [
        "。",
        "，",
        ".",
        "!",
        "?",
        ";",
        ")",
        "،",
        "۔",
        "।",
        "॥",
        "|",
        "||",
        ",",
        ":"
      ],
      "fillerInjectionEnabled": true,
      "provider": "azure",
      "voiceId": "andrew",
      "speed": 1.25
    },
    "forwardingPhoneNumber": "<string>",
    "firstMessageMode": "assistant-speaks-first",
    "voicemailDetectionTypes": [
      "machine_end_beep",
      "machine_end_silence",
      "machine_end_other"
    ],
    "recordingEnabled": true,
    "endCallFunctionEnabled": true,
    "dialKeypadFunctionEnabled": true,
    "hipaaEnabled": true,
    "clientMessages": [
      "transcript",
      "hang",
      "tool-calls",
      "speech-update",
      "metadata",
      "conversation-update"
    ],
    "serverMessages": [
      "end-of-call-report",
      "status-update",
      "hang",
      "tool-calls"
    ],
    "silenceTimeoutSeconds": 30,
    "responseDelaySeconds": 0.4,
    "llmRequestDelaySeconds": 0.1,
    "numWordsToInterruptAssistant": 1,
    "maxDurationSeconds": 1800,
    "backgroundSound": "office",
    "backchannelingEnabled": true,
    "variableValues": {},
    "name": "<string>",
    "firstMessage": "<string>",
    "voicemailDetectionEnabled": true,
    "voicemailMessage": "<string>",
    "endCallMessage": "<string>",
    "endCallPhrases": [
      "<string>"
    ],
    "metadata": {},
    "serverUrl": "<string>",
    "ser

A

Ask Inkeep•5/17/24, 7:54 AM

verUrlSecret": "<string>",
    "summaryPrompt": "<string>"
  }
}

verUrlSecret": "<string>",
    "summaryPrompt": "<string>"
  }
}

verUrlSecret": "<string>",
    "summaryPrompt": "<string>"
  }
}

verUrlSecret": "<string>",
    "summaryPrompt": "<string>"
  }
}

A

Ask Inkeep•5/17/24, 7:54 AM

Ensure that you replace placeholders (e.g.,

<string>

<string>

<string>

<string>) with actual values relevant to your use case. This is the comprehensive structure required to configure various aspects of a phone call using Vapi's API (1) .

Sources
[1] Create Phone Call

Iinstant-harlequin ```json { "maxDurationSeconds": 1800, "customerId": "<string>", "customer"...

S

sacred-emeraldOP•5/17/24, 8:00 AM

generate complete json @Ask Inkeep

A

Ask Inkeep•5/17/24, 8:00 AM

Thanks for the follow-up, @AI. I'll get back to you soon.

A

Ask Inkeep•5/17/24, 8:00 AM

-----------------------------
While I generate an answer, here are some sources that might be helpful:

Outbound Calls from Python
Create Phone Call
Buy Phone Number
Update Phone Number
-----------------------------

A

Ask Inkeep•5/17/24, 8:00 AM

Answer

Here is a complete JSON payload example for creating a phone call using the Vapi API. This example includes all necessary fields and attributes that can be adjusted as per your specific requirements:

A

Ask Inkeep•5/17/24, 8:00 AM

{
  "maxDurationSeconds": 1800,
  "customerId": "exampleCustomerId",
  "customer": {
    "number": "+15555555555",
    "name": "John Doe",
    "extension": "123"
  },
  "phoneNumberId": "examplePhoneId",
  "phoneNumber": {
    "twilioPhoneNumber": "+14444444444",
    "twilioAccountSid": "exampleSid",
    "twilioAuthToken": "exampleAuthToken",
    "name": "MyCompanyLine",
    "assistantId": "exampleAssistantId",
    "serverUrl": "https://example.com/webhook",
    "serverUrlSecret": "secretKey"
  },
  "metadata": {},
  "assistantId": "exampleAssistantId",
  "assistantOverride": {
    "transcriber": {
      "provider": "deepgram",
      "model": "nova-2",
      "language": "en",
      "smartFormat": true,
      "keywords": [
        "keyword1", "keyword2"
      ]
    },
    "model": {
      "messages": [
        {
          "content": "Hello, how can I assist you today?",
          "role": "assistant",
          "function_call": {},
          "tool_calls": [
            {}
          ],
          "tool_call_id": "exampleToolCallId"
        }
      ],
      "tools": [
        {
          "type": "transferCall",
          "messages": [
            {
              "type": "request-start",
              "content": "Transferring now",
              "conditions": [
                {
                  "param": "userRequest",
                  "value": "transfer",
                  "operator": "eq"
                }
              ]
            }
          ],
          "destinations": [
            {}
          ],
          "server": {
            "url": "https://example.com/transfer",
            "secret": "transferSecretKey"
          },
          "function": {
            "name": "transferFunction",
            "description": "Transfers the call based on conditions",
            "parameters": {
              "type": "object",
              "properties": {},

{
  "maxDurationSeconds": 1800,
  "customerId": "exampleCustomerId",
  "customer": {
    "number": "+15555555555",
    "name": "John Doe",
    "extension": "123"
  },
  "phoneNumberId": "examplePhoneId",
  "phoneNumber": {
    "twilioPhoneNumber": "+14444444444",
    "twilioAccountSid": "exampleSid",
    "twilioAuthToken": "exampleAuthToken",
    "name": "MyCompanyLine",
    "assistantId": "exampleAssistantId",
    "serverUrl": "https://example.com/webhook",
    "serverUrlSecret": "secretKey"
  },
  "metadata": {},
  "assistantId": "exampleAssistantId",
  "assistantOverride": {
    "transcriber": {
      "provider": "deepgram",
      "model": "nova-2",
      "language": "en",
      "smartFormat": true,
      "keywords": [
        "keyword1", "keyword2"
      ]
    },
    "model": {
      "messages": [
        {
          "content": "Hello, how can I assist you today?",
          "role": "assistant",
          "function_call": {},
          "tool_calls": [
            {}
          ],
          "tool_call_id": "exampleToolCallId"
        }
      ],
      "tools": [
        {
          "type": "transferCall",
          "messages": [
            {
              "type": "request-start",
              "content": "Transferring now",
              "conditions": [
                {
                  "param": "userRequest",
                  "value": "transfer",
                  "operator": "eq"
                }
              ]
            }
          ],
          "destinations": [
            {}
          ],
          "server": {
            "url": "https://example.com/transfer",
            "secret": "transferSecretKey"
          },
          "function": {
            "name": "transferFunction",
            "description": "Transfers the call based on conditions",
            "parameters": {
              "type": "object",
              "properties": {},

{
  "maxDurationSeconds": 1800,
  "customerId": "exampleCustomerId",
  "customer": {
    "number": "+15555555555",
    "name": "John Doe",
    "extension": "123"
  },
  "phoneNumberId": "examplePhoneId",
  "phoneNumber": {
    "twilioPhoneNumber": "+14444444444",
    "twilioAccountSid": "exampleSid",
    "twilioAuthToken": "exampleAuthToken",
    "name": "MyCompanyLine",
    "assistantId": "exampleAssistantId",
    "serverUrl": "https://example.com/webhook",
    "serverUrlSecret": "secretKey"
  },
  "metadata": {},
  "assistantId": "exampleAssistantId",
  "assistantOverride": {
    "transcriber": {
      "provider": "deepgram",
      "model": "nova-2",
      "language": "en",
      "smartFormat": true,
      "keywords": [
        "keyword1", "keyword2"
      ]
    },
    "model": {
      "messages": [
        {
          "content": "Hello, how can I assist you today?",
          "role": "assistant",
          "function_call": {},
          "tool_calls": [
            {}
          ],
          "tool_call_id": "exampleToolCallId"
        }
      ],
      "tools": [
        {
          "type": "transferCall",
          "messages": [
            {
              "type": "request-start",
              "content": "Transferring now",
              "conditions": [
                {
                  "param": "userRequest",
                  "value": "transfer",
                  "operator": "eq"
                }
              ]
            }
          ],
          "destinations": [
            {}
          ],
          "server": {
            "url": "https://example.com/transfer",
            "secret": "transferSecretKey"
          },
          "function": {
            "name": "transferFunction",
            "description": "Transfers the call based on conditions",
            "parameters": {
              "type": "object",
              "properties": {},

{
  "maxDurationSeconds": 1800,
  "customerId": "exampleCustomerId",
  "customer": {
    "number": "+15555555555",
    "name": "John Doe",
    "extension": "123"
  },
  "phoneNumberId": "examplePhoneId",
  "phoneNumber": {
    "twilioPhoneNumber": "+14444444444",
    "twilioAccountSid": "exampleSid",
    "twilioAuthToken": "exampleAuthToken",
    "name": "MyCompanyLine",
    "assistantId": "exampleAssistantId",
    "serverUrl": "https://example.com/webhook",
    "serverUrlSecret": "secretKey"
  },
  "metadata": {},
  "assistantId": "exampleAssistantId",
  "assistantOverride": {
    "transcriber": {
      "provider": "deepgram",
      "model": "nova-2",
      "language": "en",
      "smartFormat": true,
      "keywords": [
        "keyword1", "keyword2"
      ]
    },
    "model": {
      "messages": [
        {
          "content": "Hello, how can I assist you today?",
          "role": "assistant",
          "function_call": {},
          "tool_calls": [
            {}
          ],
          "tool_call_id": "exampleToolCallId"
        }
      ],
      "tools": [
        {
          "type": "transferCall",
          "messages": [
            {
              "type": "request-start",
              "content": "Transferring now",
              "conditions": [
                {
                  "param": "userRequest",
                  "value": "transfer",
                  "operator": "eq"
                }
              ]
            }
          ],
          "destinations": [
            {}
          ],
          "server": {
            "url": "https://example.com/transfer",
            "secret": "transferSecretKey"
          },
          "function": {
            "name": "transferFunction",
            "description": "Transfers the call based on conditions",
            "parameters": {
              "type": "object",
              "properties": {},

A

Ask Inkeep•5/17/24, 8:00 AM

     "required": [
                "transferTarget"
              ]
            }
          }
        }
      ],
      "provider": "openai",
      "model": "gpt-4o",
      "fallbackModels": [
        "gpt-4-0125-preview",
        "gpt-4-0613"
      ],
      "semanticCachingEnabled": true,
      "numFastTurns": 1,
      "temperature": 1,
      "knowledgeBase": {
        "topK": 123,
        "fileIds": [
          "fileId1"
        ],
        "provider": "canonical"
      },
      "maxTokens": 525,
      "emotionRecognitionEnabled": true
    },
    "voice": {
      "inputMinCharacters": 10,
      "inputPunctuationBoundaries": [
        ".", "!"
      ],
      "fillerInjectionEnabled": true,
      "provider": "azure",
      "voiceId": "andrew",
      "speed": 1.25
    },
    "forwardingPhoneNumber": "+13333333333",
    "firstMessageMode": "assistant-speaks-first",
    "voicemailDetectionTypes": [
      "machine_end_beep"
    ],
    "recordingEnabled": true,
    "endCallFunctionEnabled": true,
    "dialKeypadFunctionEnabled": true,
    "hipaaEnabled": true,
    "clientMessages": [
      "transcript",
      "hang",
      "tool-calls",
      "speech-update",
      "metadata",
      "conversation-update"
    ],
    "serverMessages": [
      "end-of-call-report",
      "status-update",
      "hang",
      "tool-calls"
    ],
    "silenceTimeoutSeconds": 30,
    "responseDelaySeconds": 0.4,
    "llmRequestDelaySeconds": 0.1,
    "numWordsToInterruptAssistant": 1,
    "maxDurationSeconds": 1800,
    "backgroundSound": "office",
    "backchannelingEnabled": true,
    "variableValues": {},
    "name": "MyAssistant",
    "firstMessage": "Hello, how can I assist you today?",
    "voicemailDetectionEnabled": true,
    "voicemailMessage": "Please leave a message after the beep.",
    "endCallMessage": "Thank you for calling, goodbye.",
    "endCallPhrases": [
      "goodbye", "

     "required": [
                "transferTarget"
              ]
            }
          }
        }
      ],
      "provider": "openai",
      "model": "gpt-4o",
      "fallbackModels": [
        "gpt-4-0125-preview",
        "gpt-4-0613"
      ],
      "semanticCachingEnabled": true,
      "numFastTurns": 1,
      "temperature": 1,
      "knowledgeBase": {
        "topK": 123,
        "fileIds": [
          "fileId1"
        ],
        "provider": "canonical"
      },
      "maxTokens": 525,
      "emotionRecognitionEnabled": true
    },
    "voice": {
      "inputMinCharacters": 10,
      "inputPunctuationBoundaries": [
        ".", "!"
      ],
      "fillerInjectionEnabled": true,
      "provider": "azure",
      "voiceId": "andrew",
      "speed": 1.25
    },
    "forwardingPhoneNumber": "+13333333333",
    "firstMessageMode": "assistant-speaks-first",
    "voicemailDetectionTypes": [
      "machine_end_beep"
    ],
    "recordingEnabled": true,
    "endCallFunctionEnabled": true,
    "dialKeypadFunctionEnabled": true,
    "hipaaEnabled": true,
    "clientMessages": [
      "transcript",
      "hang",
      "tool-calls",
      "speech-update",
      "metadata",
      "conversation-update"
    ],
    "serverMessages": [
      "end-of-call-report",
      "status-update",
      "hang",
      "tool-calls"
    ],
    "silenceTimeoutSeconds": 30,
    "responseDelaySeconds": 0.4,
    "llmRequestDelaySeconds": 0.1,
    "numWordsToInterruptAssistant": 1,
    "maxDurationSeconds": 1800,
    "backgroundSound": "office",
    "backchannelingEnabled": true,
    "variableValues": {},
    "name": "MyAssistant",
    "firstMessage": "Hello, how can I assist you today?",
    "voicemailDetectionEnabled": true,
    "voicemailMessage": "Please leave a message after the beep.",
    "endCallMessage": "Thank you for calling, goodbye.",
    "endCallPhrases": [
      "goodbye", "

     "required": [
                "transferTarget"
              ]
            }
          }
        }
      ],
      "provider": "openai",
      "model": "gpt-4o",
      "fallbackModels": [
        "gpt-4-0125-preview",
        "gpt-4-0613"
      ],
      "semanticCachingEnabled": true,
      "numFastTurns": 1,
      "temperature": 1,
      "knowledgeBase": {
        "topK": 123,
        "fileIds": [
          "fileId1"
        ],
        "provider": "canonical"
      },
      "maxTokens": 525,
      "emotionRecognitionEnabled": true
    },
    "voice": {
      "inputMinCharacters": 10,
      "inputPunctuationBoundaries": [
        ".", "!"
      ],
      "fillerInjectionEnabled": true,
      "provider": "azure",
      "voiceId": "andrew",
      "speed": 1.25
    },
    "forwardingPhoneNumber": "+13333333333",
    "firstMessageMode": "assistant-speaks-first",
    "voicemailDetectionTypes": [
      "machine_end_beep"
    ],
    "recordingEnabled": true,
    "endCallFunctionEnabled": true,
    "dialKeypadFunctionEnabled": true,
    "hipaaEnabled": true,
    "clientMessages": [
      "transcript",
      "hang",
      "tool-calls",
      "speech-update",
      "metadata",
      "conversation-update"
    ],
    "serverMessages": [
      "end-of-call-report",
      "status-update",
      "hang",
      "tool-calls"
    ],
    "silenceTimeoutSeconds": 30,
    "responseDelaySeconds": 0.4,
    "llmRequestDelaySeconds": 0.1,
    "numWordsToInterruptAssistant": 1,
    "maxDurationSeconds": 1800,
    "backgroundSound": "office",
    "backchannelingEnabled": true,
    "variableValues": {},
    "name": "MyAssistant",
    "firstMessage": "Hello, how can I assist you today?",
    "voicemailDetectionEnabled": true,
    "voicemailMessage": "Please leave a message after the beep.",
    "endCallMessage": "Thank you for calling, goodbye.",
    "endCallPhrases": [
      "goodbye", "

     "required": [
                "transferTarget"
              ]
            }
          }
        }
      ],
      "provider": "openai",
      "model": "gpt-4o",
      "fallbackModels": [
        "gpt-4-0125-preview",
        "gpt-4-0613"
      ],
      "semanticCachingEnabled": true,
      "numFastTurns": 1,
      "temperature": 1,
      "knowledgeBase": {
        "topK": 123,
        "fileIds": [
          "fileId1"
        ],
        "provider": "canonical"
      },
      "maxTokens": 525,
      "emotionRecognitionEnabled": true
    },
    "voice": {
      "inputMinCharacters": 10,
      "inputPunctuationBoundaries": [
        ".", "!"
      ],
      "fillerInjectionEnabled": true,
      "provider": "azure",
      "voiceId": "andrew",
      "speed": 1.25
    },
    "forwardingPhoneNumber": "+13333333333",
    "firstMessageMode": "assistant-speaks-first",
    "voicemailDetectionTypes": [
      "machine_end_beep"
    ],
    "recordingEnabled": true,
    "endCallFunctionEnabled": true,
    "dialKeypadFunctionEnabled": true,
    "hipaaEnabled": true,
    "clientMessages": [
      "transcript",
      "hang",
      "tool-calls",
      "speech-update",
      "metadata",
      "conversation-update"
    ],
    "serverMessages": [
      "end-of-call-report",
      "status-update",
      "hang",
      "tool-calls"
    ],
    "silenceTimeoutSeconds": 30,
    "responseDelaySeconds": 0.4,
    "llmRequestDelaySeconds": 0.1,
    "numWordsToInterruptAssistant": 1,
    "maxDurationSeconds": 1800,
    "backgroundSound": "office",
    "backchannelingEnabled": true,
    "variableValues": {},
    "name": "MyAssistant",
    "firstMessage": "Hello, how can I assist you today?",
    "voicemailDetectionEnabled": true,
    "voicemailMessage": "Please leave a message after the beep.",
    "endCallMessage": "Thank you for calling, goodbye.",
    "endCallPhrases": [
      "goodbye", "

A

Ask Inkeep•5/17/24, 8:00 AM

hang up"
    ],
    "metadata": {},
    "serverUrl": "https://example.com/end",
    "serverUrlSecret": "endSecretKey",
    "summaryPrompt": "Summary of the call"
  }
}

hang up"
    ],
    "metadata": {},
    "serverUrl": "https://example.com/end",
    "serverUrlSecret": "endSecretKey",
    "summaryPrompt": "Summary of the call"
  }
}

hang up"
    ],
    "metadata": {},
    "serverUrl": "https://example.com/end",
    "serverUrlSecret": "endSecretKey",
    "summaryPrompt": "Summary of the call"
  }
}

hang up"
    ],
    "metadata": {},
    "serverUrl": "https://example.com/end",
    "serverUrlSecret": "endSecretKey",
    "summaryPrompt": "Summary of the call"
  }
}

A

Ask Inkeep•5/17/24, 8:00 AM

Make sure to replace placeholder values such as

exampleCustomerId

exampleCustomerId

exampleCustomerId

exampleCustomerId,

examplePhoneId

examplePhoneId

examplePhoneId

examplePhoneId,

exampleSid

exampleSid

exampleSid

exampleSid, etc., with actual values relevant to your application. This payload is comprehensive and includes configurations for advanced features like transcribing, model overrides, and call transfers (1) .

Sources
[1] Create Phone Call

L

living-lavender•5/17/24, 12:26 PM

I think this fixed your issue?

S

sacred-emeraldOP•5/17/24, 1:55 PM

yeah it's working now..Thanks buddy

AAsk Inkeep Make sure to replace placeholder values such as `exampleCustomerId`, `examplePho...

A

Ask InkeepAPP•5/17/24, 1:55 PM

Glad I could be helpful. Feel free to create a new thread with any new questions you may have.

Getting Error in POST request

Answer

Answer

Answer

Similar Threads

Similar Threads

Answer

Answer

Answer

Similar Threads