Twilio.Calls.UserDefinedMessageSubscriptions (twilio v0.2.0)

Copy Markdown

API calls: create, delete.

Summary

Functions

Subscribe to User Defined Messages for a given Call SID.

Delete a specific User Defined Message Subscription.

Like delete/3, but returns the result or raises Infusion.Runtime.Error.

Functions

create(call_sid, params \\ %{}, opts \\ [])

Subscribe to User Defined Messages for a given Call SID.

POST /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/UserDefinedMessageSubscriptions.json

Path parameters

  • call_sid (required) - The SID of the Call the User Defined Messages subscription is associated with. This refers to the Call SID that is producing the user defined messages.

{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.

Parameters

  • callback (required) - The URL we should call using the method to send user defined events to your application. URLs must contain a valid hostname (underscores are not permitted).
  • idempotency_key - A unique string value to identify API call. This should be a unique string value per API call and can be a randomly generated.
  • method - The HTTP method Twilio will use when requesting the above Url. Either GET or POST. Default is POST.

create!(call_sid, params \\ %{}, opts \\ [])

Like create/3, but returns the result or raises Infusion.Runtime.Error.

delete(call_sid, sid, opts \\ [])

@spec delete(String.t(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Infusion.Runtime.Error.t()}

Delete a specific User Defined Message Subscription.

DELETE /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/UserDefinedMessageSubscriptions/{Sid}.json

Path parameters

  • call_sid (required) - The SID of the Call the User Defined Message Subscription is associated with. This refers to the Call SID that is producing the User Defined Messages.
  • sid (required) - The SID that uniquely identifies this User Defined Message Subscription.

{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.

delete!(call_sid, sid, opts \\ [])

@spec delete!(String.t(), String.t(), keyword()) :: nil

Like delete/3, but returns the result or raises Infusion.Runtime.Error.