GET/api/v1/numbers
Fake numbers your app sends from, with their webhooks.
- CLI
sendmock numbers list- MCP tool
sendmock_number_list- In the app
- Numbers
Answer
200 VirtualNumber[]
Numbers
GET
POST/api/v1/numbers
Add a number.
- CLI
sendmock numbers add- MCP tool
sendmock_number_upsert- In the app
- Numbers > Add number
Request body (application/json)
VirtualNumberInput : Body of POST and PATCH /api/v1/numbers.
| Field | Type | Description |
|---|---|---|
| number | string | E.164, without a channel prefix; channels says whether WhatsApp works.Example: +15550001111 |
| label | string | A name for the number, e.g. the app or feature that uses it.Example: Support line |
| channels | NumberChannel[] | Where the number works: sms, whatsapp or both.One of: sms, whatsapp |
| inbound_url | string | null | Reply webhook (Twilio "A message comes in"); null means rules only.Example: http://localhost:3000/sms/inbound |
| inbound_method | InboundWebhookMethod | The HTTP method of the reply webhook.One of: POST, GETExample: POST |
| inbound_fallback_url | string | null | Called when the reply webhook fails, with ErrorCode and ErrorUrl added, as Twilio does.Example: http://localhost:3000/sms/inbound-fallback |
| inbound_template_id | string | null | Payload template for the inbound webhook, e.g. twilio.inbound_sms.Example: twilio.inbound_sms |
| status_callback_url | string | null | Your app's URL for status changes of messages sent from this number.Example: http://localhost:3000/sms/status |
| messaging_service_sid | string | null | The Messaging Service this number belongs to, MG...; null for none.Example: MG00000000000000000000000000000001 |
Answer
201 VirtualNumber
Errors: 400, as { error: { code, message } }
Try it in Demo mode
PATCH/api/v1/numbers/{numberId}
Change a number.
- CLI
sendmock numbers update <numberId>- MCP tool
sendmock_number_upsert- In the app
- Numbers > Edit
Request body (application/json)
VirtualNumberInput : Body of POST and PATCH /api/v1/numbers.
| Field | Type | Description |
|---|---|---|
| number | string | E.164, without a channel prefix; channels says whether WhatsApp works.Example: +15550001111 |
| label | string | A name for the number, e.g. the app or feature that uses it.Example: Support line |
| channels | NumberChannel[] | Where the number works: sms, whatsapp or both.One of: sms, whatsapp |
| inbound_url | string | null | Reply webhook (Twilio "A message comes in"); null means rules only.Example: http://localhost:3000/sms/inbound |
| inbound_method | InboundWebhookMethod | The HTTP method of the reply webhook.One of: POST, GETExample: POST |
| inbound_fallback_url | string | null | Called when the reply webhook fails, with ErrorCode and ErrorUrl added, as Twilio does.Example: http://localhost:3000/sms/inbound-fallback |
| inbound_template_id | string | null | Payload template for the inbound webhook, e.g. twilio.inbound_sms.Example: twilio.inbound_sms |
| status_callback_url | string | null | Your app's URL for status changes of messages sent from this number.Example: http://localhost:3000/sms/status |
| messaging_service_sid | string | null | The Messaging Service this number belongs to, MG...; null for none.Example: MG00000000000000000000000000000001 |
Answer
200 VirtualNumber
Errors: 400, 404, as { error: { code, message } }
Try it in Demo mode
DELETE/api/v1/numbers/{numberId}
Delete a number.
- CLI
sendmock numbers remove <numberId>- MCP tool
sendmock_number_delete- In the app
- Numbers > Delete
Answer
204 No content
Try it in Demo mode
GET/api/v1/messaging-services
Messaging Services that pool numbers.
- CLI
sendmock sms services list- MCP tool
sendmock_messaging_service_list- In the app
- Numbers > Messaging Services
Answer
200 MessagingService[]
Try it in Demo mode
POST/api/v1/messaging-services
Add a Messaging Service.
- CLI
sendmock sms services create- MCP tool
sendmock_messaging_service_create- In the app
- Numbers > Messaging Services > New Messaging Service
Request body (application/json)
MessagingServiceInput : Body of POST and PATCH /api/v1/messaging-services.
| Field | Type | Description |
|---|---|---|
| friendly_name | string | A name for the service.Example: Notifications |
| number_ids | Ulid[] | The virtual numbers in the sender pool, by ID. |
| inbound_mode | MessagingServiceInboundMode | What happens to inbound messages: webhook (call inbound_url), defer_to_sender (each number's own webhook) or drop.One of: webhook, defer_to_sender, dropExample: webhook |
| inbound_url | string | null | Used when inbound_mode is webhook.Example: http://localhost:3000/sms/inbound |
| inbound_fallback_url | string | null | Called when inbound_url fails.Example: http://localhost:3000/sms/inbound-fallback |
Answer
201 MessagingService
Errors: 400, as { error: { code, message } }
Try it in Demo mode
PATCH/api/v1/messaging-services/{serviceSid}
Change a Messaging Service.
- CLI
sendmock sms services update <serviceSid>- MCP tool
sendmock_messaging_service_update- In the app
- Numbers > Messaging Services > Edit
Request body (application/json)
MessagingServiceInput : Body of POST and PATCH /api/v1/messaging-services.
| Field | Type | Description |
|---|---|---|
| friendly_name | string | A name for the service.Example: Notifications |
| number_ids | Ulid[] | The virtual numbers in the sender pool, by ID. |
| inbound_mode | MessagingServiceInboundMode | What happens to inbound messages: webhook (call inbound_url), defer_to_sender (each number's own webhook) or drop.One of: webhook, defer_to_sender, dropExample: webhook |
| inbound_url | string | null | Used when inbound_mode is webhook.Example: http://localhost:3000/sms/inbound |
| inbound_fallback_url | string | null | Called when inbound_url fails.Example: http://localhost:3000/sms/inbound-fallback |
Answer
200 MessagingService
Errors: 400, 404, as { error: { code, message } }
Try it in Demo mode
DELETE/api/v1/messaging-services/{serviceSid}
Delete a Messaging Service.
- CLI
sendmock sms services delete <serviceSid>- MCP tool
sendmock_messaging_service_delete- In the app
- Numbers > Messaging Services > Delete
Answer
204 No content