All numbers, IDs, file paths and download URLs in the examples are illustrative. Replace them with your own values before use. Keep real API keys and signed download links private.

API endpoints at a glance

1. How do I authenticate?

Include the API key issued to your account in the Authorization header. View and manage your key in the portal under Account Settings. Requests with a missing or invalid key are rejected.

Authorization: Bearer YOUR_API_KEY

2. What is required to send a fax?

PDF only. The documented maximum is approximately 10 MB, configurable. Confirm your active limit with IXICA.

3. How do I upload a PDF?

POST https://api.mysms.ca/fax/send
Content-Type: multipart/form-data

Multipart fields

from=5145551212
to=5145550000
subject=Test fax
file=@/path/to/file.pdf;type=application/pdf

cURL

curl -X POST "https://api.mysms.ca/fax/send" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "from=5145551212" \
  -F "to=5145550000" \
  -F "subject=Test fax" \
  -F "file=@/path/to/file.pdf;type=application/pdf"

Replace the file path with your PDF’s local path. In this cURL example, -F creates the multipart request; let cURL set the Content-Type boundary.

4. How do I send a PDF by URL?

POST https://api.mysms.ca/fax/send
Content-Type: application/json

{
  "from": "5145551212",
  "to": "5145550000",
  "subject": "Test fax",
  "file_url": "https://example.com/sample.pdf"
}

cURL

curl -X POST "https://api.mysms.ca/fax/send" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "from": "5145551212",
  "to": "5145550000",
  "subject": "Test fax",
  "file_url": "https://example.com/sample.pdf"
}'

The file_url must point to a PDF with content type application/pdf. The service must be able to retrieve the file.

5. What does the send response mean?

Queued — HTTP 202

{
  "success": true,
  "code": "202",
  "message": "FAX QUEUED",
  "data": {
    "fax_id": "12345",
    "from": "5145551212",
    "to": "5145550000",
    "pages": 1,
    "status": "pending"
  }
}

Store data.fax_id and use it to check status. The initial pending state is not a delivery confirmation.

Example error — HTTP 500

{
  "success": false,
  "code": "500",
  "message": "file_url must point to a PDF (application/pdf)"
}

6. How do I check outbound delivery status?

GET https://api.mysms.ca/fax/{fax_id}

Replace {fax_id} with data.fax_id returned by Send Fax. Use the same Bearer API key. Only outbound jobs are available; inbound history IDs return 404.

curl -X GET "https://api.mysms.ca/fax/12345" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Success — HTTP 200

{
  "success": true,
  "code": "200",
  "message": "OK",
  "data": {
    "fax_id": 12345,
    "direction": "outbound",
    "status": "pending",
    "from": "5145551212",
    "to": "5145550000",
    "subject": "Test fax",
    "pages": 1,
    "created_at": "2026-05-08T12:00:00+00:00",
    "updated_at": "2026-05-08T12:00:05+00:00",
    "completed_at": null
  }
}

completed_at is an ISO 8601 timestamp when the status becomes terminal (sent or failed). It remains null while in progress. Poll until a terminal state; the supplied documentation does not specify a polling interval or rate limit.

Status endpoint errors

{
  "success": false,
  "code": "401",
  "message": "INVALID API KEY"
}

7. How do inbound fax webhooks work?

If a DID has customer_fax_webhook_url configured, an event is forwarded after a fax is successfully received. The request uses POST with Content-Type: application/json.

{
  "type": "fax.received",
  "fax_id": 12345,
  "from": "5145550000",
  "to": "5145551212",
  "pages": 2,
  "status": "received",
  "received_at": "2025-08-22T12:34:56Z",
  "media_url": "https://s3.amazonaws.com/bucket/faxes/2025/08/22/fax_12345.pdf?X-Amz-Signature=..."
}

Failures to forward an event are logged; acknowledgement of the upstream webhook is not blocked. The supplied specification does not define customer-event retries or guaranteed redelivery.

8. How do I set customer_fax_webhook_url?

The specification states that this setting is configured per DID, but does not provide a configuration endpoint or portal procedure. Confirm the setup method with IXICA. Do not assume the SMS /webhook endpoint configures fax webhooks.

Troubleshooting checklist

• Use 10-digit numbers, without +1, for both from and to.
• Verify that the sending DID is assigned to your account and API functionality is enabled.
• Check the Authorization Bearer key.
• Send a PDF only and confirm the configured upload-size limit.
• Save the returned fax ID; check sent or failed rather than relying on 202 alone.
• For inbound fax, confirm the per-DID webhook URL and process the signed PDF link before expiry.

Examples contain sample numbers, media URLs and placeholder IDs—not live credentials. Replace them with your own assigned DID, recipient numbers, accessible files and API key before use.

API endpoints at a glance

1. How do I authenticate?

Include your account’s API key in every API request. View and manage the key in the portal under Account Settings. Requests with a missing or invalid key are rejected.

Authorization: Bearer YOUR_API_KEY

For the JSON requests below, also send Content-Type: application/json. Keep your real key private.

2. How do I send an SMS?

POST https://api.mysms.ca/send

Request body

{
  "from": "+15145551212",
  "to": "+15145550000",
  "text": "Hello from API"
}

Success response — HTTP 200

{
  "success": true,
  "code": "200",
  "message": "SMS SENT",
  "message_id": "<provider_msg_id>"
}

cURL

curl -X POST "https://api.mysms.ca/send" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "from": "+15145551212",
  "to": "+15145550000",
  "text": "Hello from API"
}'

PHP (Guzzle)

This example requires Guzzle and an API_KEY environment variable containing your API key.

$client = new \GuzzleHttp\Client();
$response = $client->post('https://api.mysms.ca/send', [
    'headers' => [
        'Authorization' => 'Bearer ' . getenv('API_KEY'),
        'Content-Type' => 'application/json',
    ],
    'json' => [
        'from' => '+15145551212',
        'to' => '+15145550000',
        'text' => 'Hello from API'
    ],
]);
echo $response->getStatusCode();
echo (string) $response->getBody();

3. How do I send bulk SMS?

Use the same /send endpoint, but set to to a JSON array of E.164 numbers. The same message is sent to every recipient; optional media can also be included.

{
  "from": "+15145551212",
  "to": [
    "+12025550100",
    "+12025550101"
  ],
  "text": "Same text to every recipient"
}

Queued response

{
  "success": true,
  "code": "200",
  "message": "BATCH SMS QUEUED",
  "batch_id": "<batch-uuid>",
  "queued_recipients": 2
}

cURL

curl -X POST "https://api.mysms.ca/send" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "from": "+15145551212",
  "to": [
    "+12025550100",
    "+12025550101"
  ],
  "text": "Same text to every recipient"
}'

4. How do I send an MMS?

Send a JSON request to POST https://api.mysms.ca/send with from, to and an attachments array of media URLs. The supplied MMS example does not require a text value.

{
  "from": "+15145551212",
  "to": "+15145550000",
  "attachments": [
    "https://example.com/image1.jpg",
    "https://example.com/image2.png"
  ]
}

Both phone numbers must use E.164 format. Files must be accessible over HTTPS and comply with the supported size and type limits.

Supported content types

image/jpeg, image/jpg, image/png, image/gif, video/mp4, audio/mp3, audio/mpeg, application/pdf, text/plain

The supplied specification does not give numeric file-size limits. Confirm those limits with IXICA before production use.

5. What do the response codes mean?

The JSON code field is an application code. The success examples also show HTTP 200, but these are separate values; error HTTP status mappings are not specified in the supplied reference.

6. How do I configure my inbound webhook?

POST https://api.mysms.ca/webhook
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "url": "https://yourapp.example.com/webhooks/sms"
}

Success response — HTTP 200

{
  "code": "200",
  "message": "WEBHOOK URL UPDATED"
}

Webhook updates return application code 000 for an invalid key and 200 when the URL is updated.

cURL

curl -X POST "https://api.mysms.ca/webhook" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://yourapp.example.com/webhooks/sms"
}'

7. What does an inbound SMS webhook contain?

When a message arrives on one of your DIDs, the system sends a POST request with a JSON event to your configured webhook URL.

{
  "data": {
    "event_type": "message.received",
    "id": "<uuid>",
    "completed_at": null,
    "cost": null,
    "direction": "inbound",
    "errors": [],
    "payload": {
      "id": "<uuid>",
      "from": {
        "phone_number": "+15145551212"
      },
      "text": "Hello from the sender",
      "to": [
        {
          "phone_number": "+15145550000"
        }
      ],
      "received_at": "2026-02-12T15:39:43+00:00",
      "record_type": "message"
    },
    "record_type": "event"
  }
}

8. How are inbound MMS attachments delivered?

An inbound message with attachments includes a media array under data.payload. Each item provides the media file’s public URL. The text field can be empty, as shown below.

{
  "data": {
    "event_type": "message.received",
    "id": "<uuid>",
    "direction": "inbound",
    "errors": [],
    "payload": {
      "id": "<uuid>",
      "from": {
        "phone_number": "+15145551212"
      },
      "text": "",
      "to": [
        {
          "phone_number": "+15145550000"
        }
      ],
      "media": [
        {
          "url": "https://ww2.mysms.ca/storage/mms/image1.jpg"
        },
        {
          "url": "https://ww2.mysms.ca/storage/mms/image2.png"
        }
      ],
      "received_at": "2026-02-12T15:39:43+00:00",
      "record_type": "message"
    },
    "record_type": "event"
  }
}

Inbound field reference

9. How should my webhook acknowledge receipt?

Your endpoint must return an HTTP 2xx status code to acknowledge receipt. The supplied specification does not define retry timing, delivery guarantees, a signature-verification scheme or media retention periods; confirm those details with IXICA if your application depends on them.

Troubleshooting checklist

• Confirm the from number is assigned to your user.
• Enable API functionality for the DID using the portal toggle.
• Check the Bearer API key in the Authorization header.
• Use E.164 phone numbers and valid JSON.
• For MMS, verify HTTPS accessibility and supported media types.
• For inbound messages, verify the webhook URL and return HTTP 2xx.

What do I need before starting?

• Access to your IXICA mysms account and its API Key.
• An IXICA DID assigned to your account with API messaging enabled.
• Access to your Textable profile.

1. Copy your IXICA API Key

Sign in to IXICA mysms. Open My Account from the letter/profile icon and copy your API Key.

Use the API Key, not the Secret Key. Textable’s IXICA setup instructions use the API key for outbound SMS and webhook configuration; they do not require a Secret field.

2. Enter the details in Textable

3. Configure the inbound webhook

In IXICA My Account, enter the following in API Webhook URL (SMS), then save the IXICA settings:

https://inbound.textable.app/receive?provider=ixica

Webhook Type: The linked Textable guide does not specify an IXICA Webhook Type selection. If your portal requires one, confirm the correct type with IXICA rather than copying the 3CX or Yeastar setting.

4. Save and test

1. In Textable, click Update Profile Details.
2. Send an SMS from Textable to a mobile phone.
3. Reply from that phone and confirm that the reply appears in Textable.

How do I update the webhook through the API?

This is an alternative to saving the webhook in the IXICA portal—not an additional step if it is already configured correctly. An administrator can send a POST request to https://mysms.ca/api/webhook with the IXICA API key as a Bearer token and the inbound Textable URL in the form field url.

curl --request POST 'https://mysms.ca/api/webhook' \
  --header 'Authorization: Bearer YOUR_IXICA_API_KEY' \
  --form 'url=https://inbound.textable.app/receive?provider=ixica'

Replace YOUR_IXICA_API_KEY with your own API key. For private-label accounts, replace the inbound hostname as described above. Do not publish or share the completed command with a real key.

A successful webhook update returns application response code 100. This is the code in the API response, not an HTTP status code.

What do the response codes mean?

Sending works, but replies do not appear. What should I check?

Confirm that IXICA’s inbound webhook exactly matches the Textable URL above, or your correct private-label equivalent. Make sure you saved the IXICA settings and clicked Update Profile Details in Textable.

1. Select your account and trunk option

1. Go to ORDER NEW SERVICES → SIP Services.
2. Under Account, select your existing SIP account.
3. Under Trunk, select Add new SIP trunk.

2. Complete the service details

3. Review and submit

1. Click Continue to Submit.
2. Review the submission details.
3. Select the primary contact for the ticket. This is required.
4. Click Submit SIP Request to finish submitting your order.

Final check: IP Trunk selected; valid trunk name; Primary IP entered; inbound and outbound call paths at least 1; LD Call Paths entered; Earlier Date OK? and Requested Date completed; primary contact selected.