@messagebird/sdk 0.9.0 → 0.9.2

package/dist/index.d.mts

@@ -457,6 +457,111 @@ type EventWhatsAppAccepted = {
   timestamp: string;
   data: EventWhatsAppAcceptedData;
 };
+/**
+ * Payload of the voice.call.initiated event.
+ */
+type EventVoiceCallInitiatedData = EventVoiceBase;
+/**
+ * Whether the call originated from your PBX (outbound) or arrived from a remote party (inbound).
+ */
+type VoiceCallDirection = "inbound" | "outbound";
+type VoiceSessionId = string;
+type VoiceCallId = string;
+/**
+ * Identity fields shared by every voice call lifecycle event payload.
+ */
+type EventVoiceBase = {
+  /**
+   * ID of the call record.
+   */
+  call_id: VoiceCallId;
+  /**
+   * Session identifier shared across all legs of a multi-party or transferred call. Use this to correlate related call records. Null when session correlation is not available for the call.
+   */
+  session_id?: VoiceSessionId | null;
+  /**
+   * ID of the workspace.
+   */
+  workspace_id: WorkspaceId;
+  direction: VoiceCallDirection;
+  /**
+   * Calling party number in E.164 format.
+   */
+  src_number: string;
+  /**
+   * Called party number in E.164 format.
+   */
+  dst_number: string;
+};
+/**
+ * A call was initiated — Bird received the INVITE and began routing it.
+ */
+type EventVoiceCallInitiated = {
+  /**
+   * Event type.
+   */
+  type: "voice.call.initiated";
+  /**
+   * Time the call was initiated.
+   */
+  timestamp: string;
+  data: EventVoiceCallInitiatedData;
+};
+/**
+ * Call status. v1 records are always terminal and carry one of answered, no_answer, failed, rejected, or unknown. The remaining values are declared ahead of planned features so their arrival is not a breaking contract change: busy and canceled arrive with inbound (DID) termination — today both outcomes are folded into failed — and ringing and in_progress with a live-calls surface.
+ *
+ */
+type VoiceCallStatus = "answered" | "no_answer" | "busy" | "canceled" | "failed" | "rejected" | "unknown" | "ringing" | "in_progress";
+/**
+ * Payload of the voice.call.ended event.
+ */
+type EventVoiceCallEndedData = EventVoiceBase & {
+  status: VoiceCallStatus;
+  /**
+   * Final SIP response code received from the carrier. Null when no SIP response was received, for example on timeout or DNS failure.
+   */
+  sip_response_code: number | null;
+  /**
+   * Total call duration in milliseconds, measured from the first INVITE to the BYE or final response.
+   */
+  duration_ms: number;
+  /**
+   * Billable duration in milliseconds, measured from answer to call end. Zero for unanswered calls.
+   */
+  billable_ms: number;
+};
+/**
+ * The call ended — a BYE or final non-2xx response was received and the call record was written.
+ */
+type EventVoiceCallEnded = {
+  /**
+   * Event type.
+   */
+  type: "voice.call.ended";
+  /**
+   * When the call ended (BYE or final non-2xx response).
+   */
+  timestamp: string;
+  data: EventVoiceCallEndedData;
+};
+/**
+ * Payload of the voice.call.answered event.
+ */
+type EventVoiceCallAnsweredData = EventVoiceBase;
+/**
+ * The called party answered — the carrier returned a 200 OK and media is flowing.
+ */
+type EventVoiceCallAnswered = {
+  /**
+   * Event type.
+   */
+  type: "voice.call.answered";
+  /**
+   * Time the call was answered.
+   */
+  timestamp: string;
+  data: EventVoiceCallAnsweredData;
+};
 /**
  * Payload of the sms.undelivered event.
  */
@@ -1569,6 +1674,12 @@ type WebhookEvent = ({
 } & EventSmsSent) | ({
   type: "sms.undelivered";
 } & EventSmsUndelivered) | ({
+  type: "voice.call.answered";
+} & EventVoiceCallAnswered) | ({
+  type: "voice.call.ended";
+} & EventVoiceCallEnded) | ({
+  type: "voice.call.initiated";
+} & EventVoiceCallInitiated) | ({
   type: "whatsapp.accepted";
 } & EventWhatsAppAccepted) | ({
   type: "whatsapp.delivered";
@@ -4730,6 +4841,9 @@ declare const WebhookEventType: {
   readonly SmsRejected: "sms.rejected";
   readonly SmsSent: "sms.sent";
   readonly SmsUndelivered: "sms.undelivered";
+  readonly VoiceCallAnswered: "voice.call.answered";
+  readonly VoiceCallEnded: "voice.call.ended";
+  readonly VoiceCallInitiated: "voice.call.initiated";
   readonly WhatsappAccepted: "whatsapp.accepted";
   readonly WhatsappDelivered: "whatsapp.delivered";
   readonly WhatsappFailed: "whatsapp.failed";

package/dist/index.mjs

@@ -3153,9 +3153,9 @@ var BirdClient = class {
 		this.#headers = {
 			...opts.defaultHeaders,
 			Authorization: `Bearer ${opts.apiKey}`,
-			"User-Agent": `bird-sdk-js/0.9.0`,
+			"User-Agent": `bird-sdk-js/0.9.2`,
 			"Bird-Surface": "sdk-js",
-			"Bird-Version": "0.9.0"
+			"Bird-Version": "0.9.2"
 		};
 		const caller = detectCaller();
 		if (caller) this.#headers["Bird-Caller"] = caller;
@@ -3274,6 +3274,9 @@ const WebhookEventType = {
 	SmsRejected: "sms.rejected",
 	SmsSent: "sms.sent",
 	SmsUndelivered: "sms.undelivered",
+	VoiceCallAnswered: "voice.call.answered",
+	VoiceCallEnded: "voice.call.ended",
+	VoiceCallInitiated: "voice.call.initiated",
 	WhatsappAccepted: "whatsapp.accepted",
 	WhatsappDelivered: "whatsapp.delivered",
 	WhatsappFailed: "whatsapp.failed",