@vonage/voice
Version:
The Voice API lets you create outbound calls, control in-progress calls and get information about historical calls.
30 lines (28 loc) • 898 B
TypeScript
/**
* Represents a phone endpoint, which can be used as a call destination.
*/
type PhoneEndpoint = {
/**
* Specifies the type of endpoint, which is 'phone' for phone numbers.
*/
type: 'phone';
/**
* The phone number associated with the endpoint.
*/
number: string;
/**
* Provide DTMF digits to send when the call is answered
*/
dtmfAnswer?: string;
/**
* STIR/SHAKEN Identity Header content for FCC-mandated call signing to the
* USA. Composed of the JWT (header, payload, and signature), an `info`
* parameter with a link for the certificate, the `alg` parameter indicating
* the encryption type, and the passport type (`ppt`) which should be
* `shaken`.
*
* @see {@link https://www.rfc-editor.org/rfc/rfc8225}
*/
shaken?: string;
} & Record<string, unknown>;
export type { PhoneEndpoint };