Verify tools

`sendmock_verify_force`

Force an outcome: approved, expired, canceled or max attempts.

Toolset verify.

Input	Type	Description
verification_sidrequired	string	The verification's SID, from `GET /api/v1/verify`.Example: `VE00000000000000000000000000000001`
staterequired	string	The state to force: `approved`, `canceled`, `expired` or `max_attempts` (too many wrong checks).One of: `approved`, `canceled`, `expired`, `max_attempts`Example: `expired`

Example call

{
  "name": "sendmock_verify_force",
  "arguments": {
    "verification_sid": "VE00000000000000000000000000000001",
    "state": "expired"
  }
}

Result: VerificationDetail

API: POST/api/v1/verify/{verificationSid}/force
CLI: sendmock verify force <verificationSid> <status>
In the app: SMS > Verify > verification > Approve, Cancel, Expire, Max attempts

`sendmock_verify_get`

One verification with its code, attempts and timeline.

Toolset verify.

Read only

Input	Type	Description
verification_sidrequired	string	The verification's SID, from `GET /api/v1/verify`.Example: `VE00000000000000000000000000000001`

Example call

{
  "name": "sendmock_verify_get",
  "arguments": {
    "verification_sid": "VE00000000000000000000000000000001"
  }
}

Result: VerificationDetail

API: GET/api/v1/verify/{verificationSid}
CLI: sendmock verify show <verificationSid>
In the app: SMS > Verify > open a verification

`sendmock_verify_list`

Verifications your app started, newest first.

Toolset verify.

Read only

Input	Type	Description
cursor	string	The next_cursor of the previous page.Example: `01JB7T9Q2R5W8X3Y6Z1A4B7C9D`
limit	integer	Items per page, 1 to 200 (default 50).Example: `50`
status	string	pending, approved or failed.Example: `pending`
to	string	Number or email.Example: `+8801700000000`
channel	string	How the code was sent.One of: `sms`, `whatsapp`, `email`, `call`Example: `sms`
project	string	Only this project's verifications (its key); every project's when not set.Example: `shop`

Example call

{
  "name": "sendmock_verify_list",
  "arguments": {
    "cursor": "01JB7T9Q2R5W8X3Y6Z1A4B7C9D",
    "limit": 50
  }
}

Result: PageOf_Verification

API: GET/api/v1/verify
CLI: sendmock verify list
In the app: SMS > Verify

`sendmock_verify_service_create`

Add a Verify service.

Toolset verify.

Input	Type	Description
friendly_namerequired	string	The name shown in the code message, e.g. "Your Shop verification code is ...".Example: `Shop`
code_lengthrequired	number	Digits in each code, 4 to 10.Example: `6`
fixed_code	string	Always send this code instead of a random one, for deterministic tests; null for random.Example: `123456`
ttl_secondsrequired	number	How long a code stays valid, in seconds.Example: `600`

Example call

{
  "name": "sendmock_verify_service_create",
  "arguments": {
    "friendly_name": "Shop",
    "code_length": 6,
    "ttl_seconds": 600,
    "fixed_code": "123456"
  }
}

Result: VerifyService

API: POST/api/v1/verify/services
CLI: sendmock verify services create
In the app: SMS > Verify > Services > New service

`sendmock_verify_service_delete`

Delete a Verify service.

Toolset verify.

Destructive
Idempotent

Input	Type	Description
service_sidrequired	string	The service SID: `MG...` for a Messaging Service, `VA...` for a Verify service.Example: `MG00000000000000000000000000000001`

Example call

{
  "name": "sendmock_verify_service_delete",
  "arguments": {
    "service_sid": "MG00000000000000000000000000000001"
  }
}

Result: nothing

API: DELETE/api/v1/verify/services/{serviceSid}
CLI: sendmock verify services delete <serviceSid>
In the app: SMS > Verify > Services > Delete

`sendmock_verify_service_list`

Verify services (code length, fixed code, lifetime).

Toolset verify.

Read only

No inputs.

Example call

{
  "name": "sendmock_verify_service_list",
  "arguments": {}
}

Result: VerifyService[]

API: GET/api/v1/verify/services
CLI: sendmock verify services list
In the app: SMS > Verify > Services

`sendmock_verify_service_update`

Change a Verify service.

Toolset verify.

Idempotent

Input	Type	Description
service_sidrequired	string	The service SID: `MG...` for a Messaging Service, `VA...` for a Verify service.Example: `MG00000000000000000000000000000001`
friendly_namerequired	string	The name shown in the code message, e.g. "Your Shop verification code is ...".Example: `Shop`
code_lengthrequired	number	Digits in each code, 4 to 10.Example: `6`
fixed_code	string	Always send this code instead of a random one, for deterministic tests; null for random.Example: `123456`
ttl_secondsrequired	number	How long a code stays valid, in seconds.Example: `600`

Example call

{
  "name": "sendmock_verify_service_update",
  "arguments": {
    "service_sid": "MG00000000000000000000000000000001",
    "friendly_name": "Shop",
    "code_length": 6,
    "ttl_seconds": 600,
    "fixed_code": "123456"
  }
}

Result: VerifyService

API: PATCH/api/v1/verify/services/{serviceSid}
CLI: sendmock verify services update <serviceSid>
In the app: SMS > Verify > Services > Edit