Test sending an SMS message

This endpoint allows you to send a test SMS message using the configured SMS integration settings for a specific App Integration. It is useful for verifying that your SMS provider credentials (e.g., API keys, sender ID, etc.) are correctly set up and functioning.

Use this to confirm the integration works before enabling SMS notifications or sending real user messages.

Test sending an SMS message

post

Path parameters

appIntegrationIdstringRequired

The id of the app integration.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Body

application/jsontext/jsonapplication/*+json

Represents the data required to test sending an SMS using an external SMS integration (e.g., Twilio). This DTO is typically used to verify the integration credentials and messaging capabilities.

usernamestring · min: 1Required

The username or identifier for the SMS integration. For Twilio, this is the Account SID (String Identifier).

passwordstring · min: 1Required

The password or authentication token for the SMS integration. For Twilio, this is the Auth Token.

phoneNumberFromstring · min: 1Required

The sender's phone number used by the SMS integration. Must be in E.164 format (e.g., [phone]).

phoneNumberTostring · min: 1Required

The recipient's phone number to which the test SMS will be sent. Must be in E.164 format (e.g., [phone]).

messagestring · min: 1Required

The content of the SMS message to be sent during the test.

Responses

200

The request was successful.

application/json

This provides interfaces for API responses with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Read-onlyRequired

This is the message to be displayed to the user.

databooleanRead-onlyOptional

This is the data to be returned to the client.

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

403

The user's access was denied.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

post

/api/v1/app-integrations/{appIntegrationId}/sms/test

HTTPcURLJavaScriptPython

POST /api/v1/app-integrations/{appIntegrationId}/sms/test HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "username": "text",
  "password": "text",
  "phoneNumberFrom": "text",
  "phoneNumberTo": "text",
  "message": "text"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": true,
  "errors": []
}