Texml conference join

Webhook sent when a participant joins a TeXML conference. This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.

WEBHOOK TexmlConferenceJoinWebhook

Example

{
  "AccountSid": "f5586561-8ff0-4291-a51b-c7dfe4139ff9",
  "CallSid": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ",
  "CallSidLegacy": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ",
  "ConferenceSid": "conf_abc123def456",
  "ConnectionId": "1234567890",
  "FriendlyName": "MyConference",
  "SequenceNumber": 2,
  "StatusCallbackEvent": "participant-join",
  "Timestamp": "2024-01-15T10:31:00Z",
  "CallingPartyType": "customer",
  "From": "[phone]",
  "FromSipUri": "sip:[e-mail]",
  "ParticipantLabel": "participant-1",
  "To": "[phone]",
  "ToSipUri": "sip:[e-mail]"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

telnyx-timestamp · integer<int64> · required

Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp Unix timestamp for replay attack prevention

telnyx-signature-ed25519 · string · required

Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature Ed25519 signature of timestamp|payload for verification

Body

application/x-www-form-urlencoded

Webhook sent when a participant joins a TeXML conference.

AccountSid · string · required

The unique identifier of the account (user_id).

Example:

"f5586561-8ff0-4291-a51b-c7dfe4139ff9"

CallSid · string · required

The unique identifier of the call that joined.

Example:

"v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ"

CallSidLegacy · string · required

Legacy call identifier, same as CallSid.

Example:

"v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ"

ConferenceSid · string · required

The unique identifier of the conference.

Example:

"conf_abc123def456"

ConnectionId · string · required

The unique identifier of the connection.

Example:

"1234567890"

FriendlyName · string · required

The friendly name of the conference.

Example:

"MyConference"

SequenceNumber · integer · required

The sequence number of the event.

Example:

2

StatusCallbackEvent · enum<string> · required

The event that triggered the callback.

Available options: participant-join

Example:

"participant-join"

Timestamp · string<date-time> · required

The UTC timestamp when the webhook was generated.

Example:

"2024-01-15T10:31:00Z"

CallingPartyType · string

The type of calling party (conditional, only present if available in event).

Example:

"customer"

From · string

The phone number or SIP address of the caller (conditional, only present if available in event).

Example:

"[phone]"

FromSipUri · string

The SIP URI of the caller (conditional, only present if available in event).

Example:

"sip:[e-mail]"

ParticipantLabel · string

The label of the participant (conditional, only present if available in event).

Example:

"participant-1"

To · string

The phone number or SIP address that was called (conditional, only present if available in event).

Example:

"[phone]"

ToSipUri · string

The SIP URI of the callee (conditional, only present if available in event).

Example:

"sip:[e-mail]"

Response

200

The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.