S-Gate API reference

S-Gate API.

49 endpoints, 18 of them read-only. Every one is also a command in the orbit CLI, a method in the SDKs and a tool on the MCP server.

General

Endpoint	Scope	Parameters	CLI · MCP tool
`GET /sgate/overview` Numbers, this month's usage against your packs, and provider readiness	read	—	`orbit sgate overview` `sgate_overview`
`GET /sgate/usage` Messages this month and the last twelve, against your packs	read	—	`orbit sgate usage` `sgate_usage`

numbers

Endpoint	Scope	Parameters	CLI · MCP tool
`GET /sgate/numbers` Your numbers and whether each sends and receives messages	read	—	`orbit sgate numbers list` `sgate_numbers_list`
`PATCH /sgate/numbers/{number}` Turn messaging on or off for a number; set its provider, 10DLC campaign and help reply	write	`number` string body: `enabled` boolean, `provider` string, `campaign_id` string, `help_text` string	`orbit sgate numbers patch <number>` `sgate_numbers_patch`

providers

Endpoint	Scope	Parameters	CLI · MCP tool
`GET /sgate/providers` Providers that carry messages to phone numbers, and whether each is ready	read	—	`orbit sgate providers list` `sgate_providers_list`

messages

Endpoint	Scope	Parameters	CLI · MCP tool
`GET /sgate/messages` Message log, newest first	read	`?q` string `?number` string `?direction` in \| out `?before` integer `?limit` integer	`orbit sgate messages list` `sgate_messages_list`
`POST /sgate/messages` Send a message from one of your numbers or a sender, as text or from a template, now or later (send_at)	write	body: `from` string, `sender_id` string, `to`* string[], `body` string, `template_id` string, `variables` object, `lang` string, `category` transactional \| marketing, `send_at` string, `client_ref` string	`orbit sgate messages send` `sgate_messages_send`

optouts

Endpoint	Scope	Parameters	CLI · MCP tool
`GET /sgate/optouts` People who replied STOP to one of your numbers (and START, afterwards)	read	—	`orbit sgate optouts list` `sgate_optouts_list`

brands

Endpoint	Scope	Parameters	CLI · MCP tool
`GET /sgate/brands` Your US 10DLC brands	read	—	`orbit sgate brands list` `sgate_brands_list`
`POST /sgate/brands` Register a brand (entered as a draft)	write	body: `legal_name` string, `display_name` string, `entity_type` private \| public \| nonprofit \| government \| sole_proprietor, `tax_id` string, `country` string, `vertical` string, `website` string, `contact_email` string, `status` draft \| submitted	`orbit sgate brands create` `sgate_brands_create`
`PATCH /sgate/brands/{id}` Change a brand, or submit it for review	write	`id` string body: `legal_name` string, `display_name` string, `entity_type` private \| public \| nonprofit \| government \| sole_proprietor, `tax_id` string, `country` string, `vertical` string, `website` string, `contact_email` string, `status` draft \| submitted	`orbit sgate brands patch <id>` `sgate_brands_patch`
`DELETE /sgate/brands/{id}` Delete a brand without campaigns	write	`id` string	`orbit sgate brands delete <id>` `sgate_brands_delete`

campaigns

Endpoint	Scope	Parameters	CLI · MCP tool
`GET /sgate/campaigns` Your US 10DLC campaigns	read	—	`orbit sgate campaigns list` `sgate_campaigns_list`
`POST /sgate/campaigns` Register a campaign under one of your brands (entered as a draft)	write	body: `brand_id` string, `use_case` mixed \| account_notification \| customer_care \| delivery_notification \| 2fa \| marketing \| low_volume \| charity \| polling, `description` string, `message_flow` string, `samples` string[], `status` draft \| submitted	`orbit sgate campaigns create` `sgate_campaigns_create`
`PATCH /sgate/campaigns/{id}` Change a campaign, or submit it for review	write	`id` string body: `brand_id` string, `use_case` mixed \| account_notification \| customer_care \| delivery_notification \| 2fa \| marketing \| low_volume \| charity \| polling, `description` string, `message_flow` string, `samples` string[], `status` draft \| submitted	`orbit sgate campaigns patch <id>` `sgate_campaigns_patch`
`DELETE /sgate/campaigns/{id}` Delete a campaign; numbers sending under it are detached	write	`id` string	`orbit sgate campaigns delete <id>` `sgate_campaigns_delete`

senders

Endpoint	Scope	Parameters	CLI · MCP tool
`GET /sgate/senders` Your sender identities: names recipients see, and the numbers each sends from	read	—	`orbit sgate senders list` `sgate_senders_list`
`POST /sgate/senders` Add a sender identity (a name goes to review)	write	body: `name` string, `description` string, `numbers` string[]	`orbit sgate senders create` `sgate_senders_create`
`PATCH /sgate/senders/{id}` Change a sender; a new name goes to review again	write	`id` string body: `name` string, `description` string, `numbers` string[]	`orbit sgate senders patch <id>` `sgate_senders_patch`
`DELETE /sgate/senders/{id}` Delete a sender	write	`id` string	`orbit sgate senders delete <id>` `sgate_senders_delete`

templates

Endpoint	Scope	Parameters	CLI · MCP tool
`GET /sgate/templates` Your message templates	read	—	`orbit sgate templates list` `sgate_templates_list`
`POST /sgate/templates` Create a template (version 1)	write	body: `name` string, `category` transactional \| marketing \| otp, `default_lang` string, `bodies` object, `submit` boolean	`orbit sgate templates create` `sgate_templates_create`
`GET /sgate/templates/{id}` One template with its versions	read	`id` string	`orbit sgate templates get <id>` `sgate_templates_get`
`PATCH /sgate/templates/{id}` Change a template; new text makes a new version	write	`id` string body: `name` string, `category` transactional \| marketing \| otp, `default_lang` string, `bodies` object, `submit` boolean	`orbit sgate templates patch <id>` `sgate_templates_patch`
`DELETE /sgate/templates/{id}` Delete a template	write	`id` string	`orbit sgate templates delete <id>` `sgate_templates_delete`
`POST /sgate/templates/{id}/submit` Submit the newest version for approval	write	`id` string	`orbit sgate templates submit <id>` `sgate_templates_submit`
`POST /sgate/templates/{id}/preview` Render a version with values, without sending	write	`id` string body: `lang` string, `variables` object, `version` latest \| approved	`orbit sgate templates preview <id>` `sgate_templates_preview`

verifications

Endpoint	Scope	Parameters	CLI · MCP tool
`GET /sgate/verifications` Recent verifications, newest first	read	`?limit` integer	`orbit sgate verifications list` `sgate_verifications_list`
`POST /sgate/verifications` Send a one-time code to a YunZheng number. Events: sgate.verification.approved \| failed \| expired \| canceled	write	body: `to`* string, `sender_id` string, `from` string, `code_length` integer, `ttl_s` integer, `max_attempts` integer, `lang` string, `template_id` string, `variables` object, `client_ref` string	`orbit sgate verifications create` `sgate_verifications_create`
`GET /sgate/verifications/{id}` One verification	read	`id` string	`orbit sgate verifications get <id>` `sgate_verifications_get`
`POST /sgate/verifications/{id}/check` Check the code the person entered; every check uses an attempt	write	`id` string body: `code`* string	`orbit sgate verifications check <id>` `sgate_verifications_check`
`POST /sgate/verifications/{id}/resend` Send a new code (after 30 seconds, up to four times); the old one stops working	write	`id` string	`orbit sgate verifications resend <id>` `sgate_verifications_resend`
`POST /sgate/verifications/{id}/cancel` Cancel a pending verification	write	`id` string	`orbit sgate verifications cancel <id>` `sgate_verifications_cancel`

consents

Endpoint	Scope	Parameters	CLI · MCP tool
`GET /sgate/consents` Consent records (opt-in) for marketing	read	`?q` string `?status` granted \| revoked `?limit` integer	`orbit sgate consents list` `sgate_consents_list`
`POST /sgate/consents` Record that a person agreed to receive marketing	write	body: `recipient`* string, `sender_id` string, `source` web_form \| checkout \| keyword \| paper \| import \| api \| other, `proof`* string, `granted_at` string	`orbit sgate consents create` `sgate_consents_create`
`POST /sgate/consents/import` Record up to 1000 consents at once	write	body: `records`* object[]	`orbit sgate consents import` `sgate_consents_import`
`DELETE /sgate/consents/{id}` Withdraw a consent (the record is kept as revoked)	write	`id` string	`orbit sgate consents revoke <id>` `sgate_consents_revoke`

scheduled

Endpoint	Scope	Parameters	CLI · MCP tool
`GET /sgate/scheduled` Messages scheduled for later, and what became of them	read	`?status` string	`orbit sgate scheduled list` `sgate_scheduled_list`
`DELETE /sgate/scheduled/{id}` Cancel a scheduled message	write	`id` string	`orbit sgate scheduled cancel <id>` `sgate_scheduled_cancel`

broadcasts

Endpoint	Scope	Parameters	CLI · MCP tool
`GET /sgate/broadcasts` Your broadcasts with their reports	read	—	`orbit sgate broadcasts list` `sgate_broadcasts_list`
`POST /sgate/broadcasts` Create a broadcast (a draft) to a list of YunZheng numbers	write	body: `name` string, `category` transactional \| marketing, `sender_id` string, `from` string, `template_id` string, `lang` string, `body` string, `rate_per_min` integer, `recipients` object	`orbit sgate broadcasts create` `sgate_broadcasts_create`
`GET /sgate/broadcasts/{id}` One broadcast and its report	read	`id` string	`orbit sgate broadcasts get <id>` `sgate_broadcasts_get`
`PATCH /sgate/broadcasts/{id}` Change a draft broadcast	write	`id` string body: `name` string, `category` transactional \| marketing, `sender_id` string, `from` string, `template_id` string, `lang` string, `body` string, `rate_per_min` integer, `recipients` object	`orbit sgate broadcasts patch <id>` `sgate_broadcasts_patch`
`DELETE /sgate/broadcasts/{id}` Delete a broadcast that is not sending	write	`id` string	`orbit sgate broadcasts delete <id>` `sgate_broadcasts_delete`
`GET /sgate/broadcasts/{id}/recipients` Per-recipient results	read	`id` string `?status` pending \| sent \| delivered \| failed \| opted_out \| no_consent \| skipped `?limit` integer `?offset` integer	`orbit sgate broadcasts recipients <id>` `sgate_broadcasts_recipients`
`POST /sgate/broadcasts/{id}/start` Start now or at start_at. Event when finished: sgate.broadcast.completed	write	`id` string body: `start_at` string	`orbit sgate broadcasts start <id>` `sgate_broadcasts_start`
`POST /sgate/broadcasts/{id}/pause` Pause sending	write	`id` string	`orbit sgate broadcasts pause <id>` `sgate_broadcasts_pause`
`POST /sgate/broadcasts/{id}/resume` Resume sending	write	`id` string	`orbit sgate broadcasts resume <id>` `sgate_broadcasts_resume`
`POST /sgate/broadcasts/{id}/cancel` Stop for good; recipients not reached are marked skipped	write	`id` string	`orbit sgate broadcasts cancel <id>` `sgate_broadcasts_cancel`

Account API reference

Every Account endpoint in the Orbit API (10): method and path, the token scope it needs, its parameters, and the matching CLI command and MCP tool.

Organization API reference

Every Organization endpoint in the Orbit API (10): method and path, the token scope it needs, its parameters, and the matching CLI command and MCP tool.

Services API reference

Every Services endpoint in the Orbit API (15): method and path, the token scope it needs, its parameters, and the matching CLI command and MCP tool.

← All documentation