Skip to main content

SMS Senders

SMS Sender Approval​

Sending SMS messages through Arpoone requires the intended sender to be properly authorized.

The authorization process consists of the following steps:

  • Request the sender through the platform or programmatically via the API:
    • In both cases, you must specify the sender text and attach (or provide through the API) a supporting document proving the legitimacy of using the requested sender;
    • Via the Platform: Navigate to: Profile Picture → Settings → Senders → SMS Senders. This video demonstrates the process.
    • Via the API: Call the SMS sender creation endpoint.
  • Wait for approval from the Arpoone team. A notification email will be sent once the request has been approved.
  • After approval, the user who submitted the request will automatically be associated with the sender and can immediately start sending messages using the approved sender. If additional users within the organization need access to the sender, the associations can be managed through the platform by opening the sender details.

SMS Sender Validation Rules​

SMS senders can be alphanumeric or numeric and must comply with the following validation rules:

  • Alphanumeric senders: Allows between 1 and 11 alphanumeric characters, including spaces and the following special characters: _, ,, ., +, and -.
  • Numeric senders: Allows between 1 and 16 characters, containing numbers only (0-9). The + character is allowed as the first character.

SMS Sender Creation Endpoint​

The SMS sender creation endpoint allows you to submit a request for a new SMS sender. The request will be submitted to the approval process performed by the Arpoone team. Once approved, the sender will be available for use when sending SMS messages.

You can check the sender approval status through the Arpoone platform by navigating to: Profile Picture → Settings → Senders → SMS Senders.

The operation accepts the following fields:

  • organizationId - Identifier of the organization where the sender will be configured.
  • sender - Sender text.
  • file - Object containing the supporting file submitted for approval.
    • mimeType - MIME type of the file.
      • Supported values: text/plain, application/pdf, image/png, image/jpeg
    • name - File name.
      • Supported extensions: .txt, .pdf, .png, .jpg, .jpeg
    • base64Content - Base64-encoded file content. Maximum size: 10 MB.

Example:

{
  "organizationId": "02f5d8fc-1317-487c-82ba-7d9b900e0c46",
  "sender": "sender",
  "file": {
    "mimeType": "image/png",
    "name": "proof.png",
    "base64Content": "iVBORw0KGgoAA..."
  }
}

Response​

A successful response returns information about the sender request:

  • senderRequestId – Sender request identifier.
  • requestingOrganizationId – Organization that submitted the request.
  • sender – Sender text.
  • status – Sender approval status (defaults to PENDING).
    • Possible values: PENDING, APPROVED, REFUSED

Example:

"senderRequest": {
    "senderRequestId": "8a681239-2630-4f38-bd42-f1e184e436e7",
    "requestingOrganizationId": "02f5d8fc-1317-487c-82ba-7d9b900e0c46",
    "sender": "sender",
    "status": "PENDING"
  },
  "error": {
    "code": null,
    "param": null,
    "description": null
  }
}

Errors​

If an error occurs, the error.code property indicates the type of error. The complete list of error codes is available here.

Go to API Reference