PhonesApi
All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| phonesCreatePhoneVerification | POST /{tenantId}/phones/{phoneNumber}/verifications | Create a new verification for a phone number. |
| phonesCreatePhoneVerificationV2 | POST /{tenantId}/phones/verifications | Create a new verification for a phone number. |
| phonesLookupPhone | POST /{tenantId}/phones/lookup | Lookup information about a phone such as carrier, type, and supported channels. |
| phonesVerifyPhone | POST /{tenantId}/phones/{phoneNumber}/verifications/{verificationId}/verify | Attempt to verify a phone number. |
| phonesVerifyPhoneV2 | POST /{tenantId}/phones/verifications/{verificationId}/verify | Attempt to verify a phone number. |
phonesCreatePhoneVerification
PendingVerificationSummary phonesCreatePhoneVerification(tenantId, phoneNumber, CreateVerificationRequest)
Create a new verification for a phone number.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantId | String | [default to null] | |
| phoneNumber | String | [default to null] | |
| CreateVerificationRequest | CreateVerificationRequest | [optional] |
Return type
Authorization
Oauth2Scheme, Oauth2Scheme, JwtBearerTokenScheme
HTTP request headers
- Content-Type: application/json-patch+json, application/json, text/json, application/*+json
- Accept: application/json
phonesCreatePhoneVerificationV2
PendingVerificationSummary phonesCreatePhoneVerificationV2(tenantId, CreateVerificationCommand)
Create a new verification for a phone number.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantId | String | [default to null] | |
| CreateVerificationCommand | CreateVerificationCommand | [optional] |
Return type
Authorization
Oauth2Scheme, Oauth2Scheme, JwtBearerTokenScheme
HTTP request headers
- Content-Type: application/json-patch+json, application/json, text/json, application/*+json
- Accept: application/json
phonesLookupPhone
PhoneInformation phonesLookupPhone(tenantId, LookupPhoneQuery)
Lookup information about a phone such as carrier, type, and supported channels.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantId | String | [default to null] | |
| LookupPhoneQuery | LookupPhoneQuery | [optional] |
Return type
Authorization
Oauth2Scheme, Oauth2Scheme, JwtBearerTokenScheme
HTTP request headers
- Content-Type: application/json-patch+json, application/json, text/json, application/*+json
- Accept: application/json
phonesVerifyPhone
phonesVerifyPhone(tenantId, phoneNumber, verificationId, VerificationRequest)
Attempt to verify a phone number.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantId | String | [default to null] | |
| phoneNumber | String | [default to null] | |
| verificationId | String | [default to null] | |
| VerificationRequest | VerificationRequest | [optional] |
Return type
null (empty response body)
Authorization
Oauth2Scheme, Oauth2Scheme, JwtBearerTokenScheme
HTTP request headers
- Content-Type: application/json-patch+json, application/json, text/json, application/*+json
- Accept: application/json
phonesVerifyPhoneV2
phonesVerifyPhoneV2(tenantId, verificationId, VerificationCommand)
Attempt to verify a phone number.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tenantId | String | [default to null] | |
| verificationId | String | [default to null] | |
| VerificationCommand | VerificationCommand | [optional] |
Return type
null (empty response body)
Authorization
Oauth2Scheme, Oauth2Scheme, JwtBearerTokenScheme
HTTP request headers
- Content-Type: application/json-patch+json, application/json, text/json, application/*+json
- Accept: application/json