Twilio.Verify.V2.Service.VerificationService (twilio_elixir v0.1.1)

Service for Verification API operations.

Operations: create, fetch, update

Summary

Functions

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

Create a new Verification using a Service

fetch(client, service_sid, sid, opts \\ [])

Fetch a specific Verification

update(client, service_sid, sid, params \\ %{}, opts \\ [])

Update a Verification status

Functions

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

@spec create(Twilio.Client.t(), String.t(), map(), keyword()) ::
  {:ok, Twilio.Resources.Verify.V2.Service.Verification.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Create a new Verification using a Service

Operation: CreateVerification | Tags: VerifyV2Verification

Required Parameters

Parameter	Type	Description

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| Channel | string | The verification method to use. One of: email, sms, whatsapp, call, sna or auto. |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| To | string | The phone number or email to verify. Phone numbers must be in E.164 format. |

Optional Parameters

Parameter	Type	Description

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| Amount | string | The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled. |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| AppHash | string | Your App Hash to be appended at the end of your verification SMS body. Applies only to SMS. Example SMS body: <#> Your AppName verification code is: 1234 He42w354ol9. |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| ChannelConfiguration | string | email channel configuration in json format. The fields 'from' and 'from_name' are optional but if included the 'from' field must have a valid email address. |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| CustomCode | string | A pre-generated code to use for verification. The code can be between 4 and 10 characters, inclusive. |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

`CustomFriendlyName`	string	A custom user defined friendly name that overwrites the existing one in the verification message
`CustomMessage`	string	The text of a custom message to use for the verification.

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| DeviceIp | string | Strongly encouraged if using the auto channel. The IP address of the client's device. If provided, it has to be a valid IPv4 or IPv6 address. |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| EnableSnaClientToken | boolean | An optional Boolean value to indicate the requirement of sna client token in the SNA URL invocation response for added security. This token must match in the Verification Check request to confirm phone number verification. |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

`Locale`	string	Locale will automatically resolve based on phone number country code for SMS, WhatsApp, and call channel verifications. It will fallback to English or the template’s default translation if the selected translation is not available. This parameter will override the automatic locale resolution. See supported languages and more information here.
`Payee`	string	The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

`RateLimits`	string	The custom key-value pairs of Programmable Rate Limits. Keys correspond to `unique_name` fields defined when creating your Rate Limit. Associated value pairs represent values in the request that you are rate limiting on. You may include multiple Rate Limit values in each request.
`RiskCheck`	string	Values: `enable`, `disable`

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| SendDigits | string | The digits to send after a phone call is answered, for example, to dial an extension. For more information, see the Programmable Voice documentation of sendDigits. |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| Tags | string | A string containing a JSON map of key value pairs of tags to be recorded as metadata for the message. The object may contain up to 10 tags. Keys and values can each be up to 128 characters in length. |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| TemplateCustomSubstitutions | string | A stringified JSON object in which the keys are the template's special variables and the values are the variables substitutions. |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| TemplateSid | string | The message template. If provided, will override the default template for the Service. SMS and Voice channels only. |

fetch(client, service_sid, sid, opts \\ [])

@spec fetch(Twilio.Client.t(), String.t(), String.t(), keyword()) ::
  {:ok, Twilio.Resources.Verify.V2.Service.Verification.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Fetch a specific Verification

Operation: FetchVerification | Tags: VerifyV2Verification

update(client, service_sid, sid, params \\ %{}, opts \\ [])

@spec update(Twilio.Client.t(), String.t(), String.t(), map(), keyword()) ::
  {:ok, Twilio.Resources.Verify.V2.Service.Verification.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Update a Verification status

Operation: UpdateVerification | Tags: VerifyV2Verification

Required Parameters

Parameter	Type	Description
`Status`	string	Values: `canceled`, `approved`