VAPI•2y ago

How to get customerId for outboundPhoneCall

Hi Community,

I am working on a project where I need to utilize VAPI's official API to initiate an outboundPhoneCall. Here is the reference url to the endpoint I am looking at https://docs.vapi.ai/api-reference/calls/create-phone-call

Not as you can see

customerID

customerID

customerID

customerID is one of the required parameters for me to initiate a call.

Can you please help me understand what's this

customerID

customerID

customerID

customerID is it something VAPI offers before making a call to a lead's phone number? Or can i specify any unique string as the

customerID

customerID

customerID

customerID

Any help would be greatly appreciated.

Vapi

Create Phone Call - Vapi

Ask Inkeep•6/4/24, 12:45 PM

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

Ask Inkeep•6/4/24, 12:45 PM

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

Create Phone Call
Get Call
Outbound Sales Example
List Calls
-----------------------------

Ask Inkeep•6/4/24, 12:45 PM

Answer

Hi there,

In the context of Vapi's API, the customerIdcustomerId is a unique identifier that you, as the developer, assign to each customer to represent them in your system. It's not something that Vapi provides automatically. When you make an outbound call using Vapi's API, you can specify any unique string that identifies the customer in your system as the customerIdcustomerId. This ID helps you manage and track calls related to specific customers in your application.

You can see this in the structure of the API call for creating a phone call, where customerIdcustomerId is one of the parameters you can include in the request payload. Here's an example of how you might structure the request:

{
  "customerId": "unique_customer_id_string",
  "customer": {
    "number": "+11234567890",
    "name": "John Doe"
  },
  "phoneNumberId": "your_phone_number_id",
  "assistantId": "your_assistant_id"
}

{
  "customerId": "unique_customer_id_string",
  "customer": {
    "number": "+11234567890",
    "name": "John Doe"
  },
  "phoneNumberId": "your_phone_number_id",
  "assistantId": "your_assistant_id"
}

This format allows you to link the call directly to a customer record in your database. Make sure that the customerIdcustomerId is unique and meaningful within your system to avoid conflicts or confusion.

If you need further details on how to structure your API requests, you can refer to the documentation on creating phone calls here (1) .

I hope this helps! Let me know if you have any more questions.

: Create Phone Call

Sources
[1] Create Phone Call

living-lavender•6/5/24, 3:50 AM

You don't need that you just need to provide the phone number that's all

ordinary-sapphireOP•6/5/24, 9:36 AM

Hi Sahil

ordinary-sapphireOP•6/5/24, 9:37 AM

I am using the following JSON as Body

{
"customer": {
"number": "+918437405304",
"name": "Vikas Goyal",
"extension": "+91"
},
"phoneNumberId": "<string>",
"metadata": {},
"assistantId": "<string>",
"squadId": "1"
}

but it said

{
"message": [
"squadId must be a UUID",
"phoneNumberId must be a UUID"
],
"error": "Bad Request",
"statusCode": 400
}

ordinary-sapphireOP•6/5/24, 9:37 AM

what does it mean by squadId must be UUID and phoenumber must be UUID

spotty-amber•6/5/24, 9:43 AM

Remove the squad part.

ordinary-sapphireOP•6/5/24, 9:46 AM

Thanks for squad

ordinary-sapphireOP•6/5/24, 9:46 AM

what about phoneNumberID

ordinary-sapphireOP•6/5/24, 9:47 AM

I am using a number that is in my VAPI Dashboard

ordinary-sapphireOP•6/5/24, 9:50 AM

I got it @Chowderr

spotty-amber•6/5/24, 9:53 AM

Go to your phone numbers and select the ID.

How to get customerId for outboundPhoneCall

Answer

Similar Threads

Similar Threads

Answer

Similar Threads