TwilioIncomingCallPayload

Defined in: lib/webhook/twilio-webhook.payloads.ts:269

Body of Twilio’s request when a call arrives, and of any subsequent request to a TwiML action URL.

Example

@Post('webhooks/voice')
@TwilioWebhook()
@UseInterceptors(TwimlInterceptor)
answer(@Body() payload: TwilioIncomingCallPayload) {
  const response = new twilio.twiml.VoiceResponse();
  response.say(`Hello from ${payload.FromCity ?? 'an unknown city'}`);
  return response;
}

See

https://www.twilio.com/docs/voice/twiml#request-parameters

Extends

• TwilioGeoParams

Extended by

• TwilioCallStatusPayload

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
AccountSid	readonly	string	SID of the account handling the call. Starts with AC.	-	lib/webhook/twilio-webhook.payloads.ts:273
ApiVersion?	readonly	string	Twilio API version handling the call, e.g. '2010-04-01'.	-	lib/webhook/twilio-webhook.payloads.ts:285
CallerName?	readonly	string	Caller’s name, when the number has caller-ID lookup enabled.	-	lib/webhook/twilio-webhook.payloads.ts:289
CallSid	readonly	string	Unique identifier for the call. Starts with CA.	-	lib/webhook/twilio-webhook.payloads.ts:271
CallStatus	readonly	TwilioCallStatus	-	-	lib/webhook/twilio-webhook.payloads.ts:282
CallToken?	readonly	string	Token required to invoke a forwarded call.	-	lib/webhook/twilio-webhook.payloads.ts:293
Direction	readonly	TwilioCallDirection	-	-	lib/webhook/twilio-webhook.payloads.ts:283
ForwardedFrom?	readonly	string	Number the call was forwarded from, when the carrier supplies it.	-	lib/webhook/twilio-webhook.payloads.ts:287
From	readonly	string	Caller’s number or client identifier. Client identifiers use the client: scheme, e.g. client:charlie. May be anonymous or unknown when caller ID is withheld.	-	lib/webhook/twilio-webhook.payloads.ts:279
FromCity?	readonly	string	-	TwilioGeoParams.FromCity	lib/webhook/twilio-webhook.payloads.ts:76
FromCountry?	readonly	string	-	TwilioGeoParams.FromCountry	lib/webhook/twilio-webhook.payloads.ts:79
FromState?	readonly	string	-	TwilioGeoParams.FromState	lib/webhook/twilio-webhook.payloads.ts:77
FromZip?	readonly	string	-	TwilioGeoParams.FromZip	lib/webhook/twilio-webhook.payloads.ts:78
ParentCallSid?	readonly	string	SID of the call that created this leg. Absent on a first leg.	-	lib/webhook/twilio-webhook.payloads.ts:291
To	readonly	string	Called number or client identifier.	-	lib/webhook/twilio-webhook.payloads.ts:281
ToCity?	readonly	string	-	TwilioGeoParams.ToCity	lib/webhook/twilio-webhook.payloads.ts:80
ToCountry?	readonly	string	-	TwilioGeoParams.ToCountry	lib/webhook/twilio-webhook.payloads.ts:83
ToState?	readonly	string	-	TwilioGeoParams.ToState	lib/webhook/twilio-webhook.payloads.ts:81
ToZip?	readonly	string	-	TwilioGeoParams.ToZip	lib/webhook/twilio-webhook.payloads.ts:82