SMS

Register an SMS sender ID for the current company. Optionally attach verification documents as multipart files. New senders start unverified pending review.

post/api/v1/sms/senders

Request

  • Base URL: https://api.voicelogica.ai
  • URL: https://api.voicelogica.ai/api/v1/sms/senders
  • Auth: API key in header x-api-key

Headers

x-api-keystring required

Your API key for authentication. Required for all endpoints.

x-company-idstring

Optional company ID for resellers. When provided, the API request will operate on behalf of the specified subsidiary company. The API key must have access to the specified company.

Request body

senderIdstring required

Sender ID to register (alphanumeric ≤11 chars or a short code; must be pre-approved with the carrier).

notesstring

Free-text notes for the approval reviewer.

documentIdsstring[]

IDs of previously uploaded verification documents.

Example request

{
  "senderId": "YouBath",
  "notes": "Company brand name for order notifications",
  "documentIds": []
}

Response

SMS sender registered

idstring required

Unique identifier

createdAtstring date-time required

Creation timestamp

activeboolean required

Whether the entity is active

createdBystring required

Name of the user who created the entity

createdByIdstring required

ID of the user who created the entity

modifiedAtstring date-time

ISO 8601 date string

modifiedBystring

Name of the user who last modified the entity

modifiedByIdstring

ID of the user who last modified the entity

companyIdstring required

Company identifier

companyobject

Any valid JSON value

groupIdsstring[]

Linked group IDs

senderIdstring required

Sender ID for SMS

documentIdsstring[]

Array of document IDs

verifiedboolean required

Whether the sender is verified

notesstring

Additional notes

Example response

{
  "id": "507f1f77bcf86cd799439011",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "active": true,
  "createdBy": "John Doe",
  "createdById": "123",
  "modifiedAt": "2024-01-15T10:30:00.000Z",
  "modifiedBy": "Jane Doe",
  "modifiedById": "456",
  "companyId": "507f1f77bcf86cd799439012",
  "senderId": "SMS_SENDER_123",
  "documentIds": [
    "doc_1",
    "doc_2"
  ],
  "documents": [
    {
      "id": "doc_1",
      "name": "business_license.pdf",
      "type": "application/pdf",
      "size": 1024000,
      "data": "base64_encoded_data"
    }
  ],
  "verified": true,
  "notes": "SMS sender setup notes"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.