SMS providers tools

`sendmock_sms_provider_create`

Add an SMS provider, blank or copied from another.

Toolset sms.

Input	Type	Description
namerequired	string	The new provider's name.Example: `SSL Wireless`
keyrequired	string	Its key in `/providers/<key>/...` paths and on messages; lowercase, fixed after creation.Example: `sslwireless`
start_from	string	A provider of the same area to copy, or null to start blank.Example: `twilio`

Example call

{
  "name": "sendmock_sms_provider_create",
  "arguments": {
    "name": "SSL Wireless",
    "key": "sslwireless",
    "start_from": "twilio"
  }
}

Result: MessageProviderDefinition

API: POST/api/v1/sms/providers
CLI: sendmock sms providers create
In the app: SMS > Providers > Add provider

`sendmock_sms_provider_delete`

Remove a built-in (restorable) or delete a custom provider; its messages stay.

Toolset sms.

Destructive
Idempotent

Input	Type	Description
provider_keyrequired	string	The email or SMS provider's key, e.g. `sendgrid` or `twilio`, from its providers list.Example: `twilio`

Example call

{
  "name": "sendmock_sms_provider_delete",
  "arguments": {
    "provider_key": "twilio"
  }
}

Result: nothing

API: DELETE/api/v1/sms/providers/{providerKey}
CLI: sendmock sms providers delete <providerKey>
In the app: SMS > Providers > provider > Remove or Delete

`sendmock_sms_provider_get`

One provider definition; secret credentials masked.

Toolset sms.

Read only

Input	Type	Description
provider_keyrequired	string	The email or SMS provider's key, e.g. `sendgrid` or `twilio`, from its providers list.Example: `twilio`

Example call

{
  "name": "sendmock_sms_provider_get",
  "arguments": {
    "provider_key": "twilio"
  }
}

Result: MessageProviderDefinition

API: GET/api/v1/sms/providers/{providerKey}
CLI: sendmock sms providers show <providerKey>
In the app: SMS > Providers > provider

`sendmock_sms_provider_list`

SMS providers, built in and custom, removed ones included.

Toolset sms.

Read only

No inputs.

Example call

{
  "name": "sendmock_sms_provider_list",
  "arguments": {}
}

Result: MessageProviderDefinition[]

API: GET/api/v1/sms/providers
CLI: sendmock sms providers list
In the app: SMS > Providers

`sendmock_sms_provider_preview`

Run a sample request through a definition: the message it would store and the answer it would give.

Toolset sms.

Read only

Input	Type	Description
provider_keyrequired	string	The email or SMS provider's key, e.g. `sendgrid` or `twilio`, from its providers list.Example: `twilio`
providerrequired	MessageProviderInput	The provider settings to run, saved or not.
sample_request	ProviderSampleRequest	The request to run; the provider's example send when left out.

Example call

{
  "name": "sendmock_sms_provider_preview",
  "arguments": {
    "provider_key": "twilio",
    "provider": {
      "key": "sendgrid",
      "name": "SendGrid",
      "accent": "#1a82e2",
      "is_enabled": true,
      "host": "api.sendgrid.com",
      "credentials": [
        {
          "name": "api_key",
          "value": "SG.test_key_123",
          "is_secret": true
        }
      ],
      "check_credentials": false,
      "operations": [
        {
          "kind": "send",
          "method": "POST",
          "path": "/v3/{domain}/messages",
          "request_format": "multipart"
        }
      ],
      "field_mapping": [
        {
          "part": "to",
          "source": "personalizations[0].to[*].email"
        }
      ],
      "validation_rules": [
        {
          "part": "to",
          "check": "required",
          "max_length": null,
          "error_kind": "missing_field"
        }
      ],
      "success_response": {
        "status": 202,
        "headers": [
          {
            "name": "X-Message-Id",
            "template": "{{ message.provider_id }}"
          }
        ],
        "body": "{\"id\": \"{{ message.provider_id }}\"}"
      },
      "error_responses": [
        {
          "kind": "missing_field",
          "status": 202,
          "headers": [
            {
              "name": "X-Message-Id",
              "template": "{{ message.provider_id }}"
            }
          ],
          "body": "{\"id\": \"{{ message.provider_id }}\"}"
        }
      ],
      "message_id_template": "<{{ uuid() }}@sendmock.local>",
      "callback_template_key": "sendgrid-event",
      "status_names": {
        "delivered": "delivered",
        "bounced": "bounce",
        "complained": "spamreport"
      },
      "outcome_error_codes": {
        "invalid_number": "21211",
        "unreachable": "30003"
      }
    }
  }
}

Result: MessageProviderPreview

API: POST/api/v1/sms/providers/{providerKey}/preview
CLI: sendmock sms providers preview <providerKey>
In the app: SMS > Providers > provider > Preview

`sendmock_sms_provider_reset`

Put a built-in provider back as shipped.

Toolset sms.

Input	Type	Description
provider_keyrequired	string	The email or SMS provider's key, e.g. `sendgrid` or `twilio`, from its providers list.Example: `twilio`

Example call

{
  "name": "sendmock_sms_provider_reset",
  "arguments": {
    "provider_key": "twilio"
  }
}

Result: MessageProviderDefinition

API: POST/api/v1/sms/providers/{providerKey}/reset
CLI: sendmock sms providers reset <providerKey>
In the app: SMS > Providers > provider > Reset to default

`sendmock_sms_provider_restore`

Bring a removed built-in back as it was.

Toolset sms.

Input	Type	Description
provider_keyrequired	string	The email or SMS provider's key, e.g. `sendgrid` or `twilio`, from its providers list.Example: `twilio`

Example call

{
  "name": "sendmock_sms_provider_restore",
  "arguments": {
    "provider_key": "twilio"
  }
}

Result: MessageProviderDefinition

API: POST/api/v1/sms/providers/{providerKey}/restore
CLI: sendmock sms providers restore <providerKey>
In the app: SMS > Providers > Removed > Restore

`sendmock_sms_provider_update`

Change a provider; 400 with the problems for template errors, bad paths or a path clash.

Toolset sms.

Idempotent

Input	Type	Description
provider_keyrequired	string	The email or SMS provider's key, e.g. `sendgrid` or `twilio`, from its providers list.Example: `twilio`
keyrequired	string	The `/providers/<key>/...` path and the `provider` value stored on each message; lowercase, fixed after creation.Example: `sendgrid`
namerequired	string	The provider's name, shown on messages and in pickers.Example: `SendGrid`
accentrequired	string	`#rrggbb`, used on its badge.Example: `#1a82e2`
is_enabledrequired	boolean	Off providers answer nothing; their paths get SendMock's native 404.Example: `true`
host	string	The provider's API host, used on the provider port to tell apart providers that share a path; null when not needed.Example: `api.sendgrid.com`
credentialsrequired	ProviderCredential[]	The credentials your app is configured with.Example: `[{"name":"api_key","value":"SG.test_key_123","is_secret":true}]`
check_credentialsrequired	boolean	Off by default: any credentials are accepted. On: wrong ones get the provider's `unauthorized` answer.Example: `false`
operationsrequired	ProviderOperation[]	The requests it answers.Example: `[{"kind":"send","method":"POST","path":"/v3/{domain}/messages","request_format":"multipart"}]`
field_mappingrequired	ProviderFieldMapping[]	Where each part of a sent message is read from; anything else is kept as metadata.Example: `[{"part":"to","source":"personalizations[0].to[*].email"}]`
validation_rulesrequired	ProviderValidationRule[]	The checks run on each send, in order.Example: `[{"part":"to","check":"required","max_length":null,"error_kind":"missing_field"}]`
success_responserequired	ProviderResponseTemplate	The answer to a request that passes every check.
error_responsesrequired	ProviderErrorResponse[]	The answer for each kind of error.Example: `[{"kind":"missing_field","status":202,"headers":[{"name":"X-Message-Id","template":"{{ message.provider_id }}"}],"body":"{\"id\": \"{{ message.provider_id }}\"}"}]`
message_id_templaterequired	string	The provider's id for each message, a template.Example: `<{{ uuid() }}@sendmock.local>`
callback_template_key	string	The webhook template its status callbacks and inbound messages are sent with; null sends none.Example: `sendgrid-event`
status_namesrequired	object	The provider's name for each SendMock status.
outcome_error_codesrequired	object	SMS only: the provider's error code for each delivery outcome, so test numbers fail with its own codes.

Example call

{
  "name": "sendmock_sms_provider_update",
  "arguments": {
    "provider_key": "twilio",
    "key": "sendgrid",
    "name": "SendGrid",
    "accent": "#1a82e2",
    "is_enabled": true,
    "credentials": [
      {
        "name": "api_key",
        "value": "SG.test_key_123",
        "is_secret": true
      }
    ],
    "check_credentials": false,
    "operations": [
      {
        "kind": "send",
        "method": "POST",
        "path": "/v3/{domain}/messages",
        "request_format": "multipart"
      }
    ],
    "field_mapping": [
      {
        "part": "to",
        "source": "personalizations[0].to[*].email"
      }
    ],
    "validation_rules": [
      {
        "part": "to",
        "check": "required",
        "max_length": null,
        "error_kind": "missing_field"
      }
    ],
    "success_response": {
      "status": 202,
      "headers": [
        {
          "name": "X-Message-Id",
          "template": "{{ message.provider_id }}"
        }
      ],
      "body": "{\"id\": \"{{ message.provider_id }}\"}"
    },
    "error_responses": [
      {
        "kind": "missing_field",
        "status": 202,
        "headers": [
          {
            "name": "X-Message-Id",
            "template": "{{ message.provider_id }}"
          }
        ],
        "body": "{\"id\": \"{{ message.provider_id }}\"}"
      }
    ],
    "message_id_template": "<{{ uuid() }}@sendmock.local>",
    "status_names": {
      "delivered": "delivered",
      "bounced": "bounce",
      "complained": "spamreport"
    },
    "outcome_error_codes": {
      "invalid_number": "21211",
      "unreachable": "30003"
    },
    "host": "api.sendgrid.com",
    "callback_template_key": "sendgrid-event"
  }
}

Result: MessageProviderDefinition

API: PATCH/api/v1/sms/providers/{providerKey}
CLI: sendmock sms providers update <providerKey>
In the app: SMS > Providers > provider > Save provider

`sendmock_sms_whatsapp_verify_webhook`

Send Meta's callback URL check to the app and report whether it answered the challenge.

Toolset sms.

Input	Type	Description
url	string	The URL to check; the WhatsApp Cloud provider's `webhook_url` when left out.Example: `http://127.0.0.1:3000/whatsapp/webhook`

Example call

{
  "name": "sendmock_sms_whatsapp_verify_webhook",
  "arguments": {
    "url": "http://127.0.0.1:3000/whatsapp/webhook"
  }
}

Result: WhatsappWebhookVerification

API: POST/api/v1/sms/whatsapp-cloud/verify-webhook
CLI: sendmock sms whatsapp-cloud verify-webhook
In the app: SMS > Providers > WhatsApp Cloud > Verify callback URL