sinch-numbers-api（sinch numbers API 搜索）

Sinch Numbers API

The Numbers API lets you search, activate, manage, and release phone numbers — the prerequisite for SMS, Voice, and Conversation APIs.

Instructions

Step 1: Choose approach

• SDK project? Default to SDK if @sinch/sdk-core (Node), sinch (Python), or com.sinch.sdk (Java) is present.
• Direct HTTP? Use curl/fetch with Basic auth.

For SDK code, read the correct reference before generating any code:

For direct HTTP calls, see Numbers API Reference.

Step 2: Authenticate

See sinch-authentication for full setup.

Step 3: Verify connectivity

curl -X GET \
  "https://numbers.api.sinch.com/v1/projects/$SINCH_PROJECT_ID/activeNumbers?regionCode=US&type=LOCAL&pageSize=10" \
  -H "Authorization: Bearer $SINCH_ACCESS_TOKEN" \
  -H "Content-Type: application/json"

A 200 response confirms credentials and project access.

Key Concepts

• Active Number — A phone number currently rented and owned by your project. Managed via /activeNumbers.
• Available Number — A phone number available for rent in a given region and type. Searched via /availableNumbers.
• Number Type — LOCAL, MOBILE, or TOLL_FREE. Required when searching or listing numbers.
• Region Code — ISO 3166-1 alpha-2 country code (e.g., US, GB, SE). Required for search and list operations.
• SMS Configuration — Settings for SMS on a number: servicePlanId, campaignId (US 10DLC only), scheduledProvisioning status.
• Voice Configuration — Discriminated union on type: RTC (requires appId), EST (requires trunkId), FAX (requires serviceId).
• Callback Configuration — Project-level HMAC secret for signature verification on number lifecycle webhooks. Does NOT set a callback URL.
• Scheduled Provisioning — Async provisioning status for SMS/voice config. Status values: WAITING, IN_PROGRESS, FAILED.

Workflows

Search and rent a number

1. GET /availableRegions — discover valid regionCode values
2. GET /availableNumbers?regionCode={code}&type={type} — search (both params required)
3. Pick a number → POST /availableNumbers/{phoneNumber}:rent with config body
4. GET /activeNumbers/{phoneNumber} — confirm activation

Use POST /availableNumbers:rentAny to skip step 3 (US LOCAL numbers only).

Safe retries for billable operations

Before retrying any potentially billable action (for example :rent, :rentAny, or :release) after an incomplete/uncertain response:

1. Check current state first using a read endpoint (GET /activeNumbers/{phoneNumber} or GET /activeNumbers with filters)
2. Retry only if the verification shows the prior action did not succeed
3. If state is ambiguous, prefer listing active numbers and matching on phoneNumber before issuing another billable request

Update number configuration

1. GET /activeNumbers/{phoneNumber} — check current config
2. PATCH /activeNumbers/{phoneNumber} — set displayName, smsConfiguration, or voiceConfiguration
3. To unlink, send empty string "" in servicePlanId or campaignId

Release a number

POST /activeNumbers/{phoneNumber}:release

Fetch all numbers to JSON

Run node scripts/get_numbers.cjs --output numbers.json (uses SINCH_PROJECT_ID, SINCH_KEY_ID, SINCH_KEY_SECRET env vars). Supports --region and --type filters.

Emergency addresses

Use the emergency address endpoints on active numbers: GET, provision, deprovision, validate. See API reference.

Number orders (KYC-regulated regions)

Use the numberOrders endpoints: lookupNumberRequirements → createNumberOrder → upload registration/attachments → submit. See API reference.

Imported numbers

A separate API at https://imported.numbers.api.sinch.com handles importing non-Sinch numbers (DCA) and hosting orders. See API reference.

Gotchas

• Param names differ between endpoints: GET /activeNumbers uses capability (singular) and pageSize. GET /availableNumbers uses capabilities (plural) and size (single page, no pagination).
• type defaults to MOBILE — omitting it returns only MOBILE numbers, not all types.
• Always set pageSize explicitly on GET /activeNumbers — no documented default.
• rentAny is US LOCAL only — use :rent for other types/regions.
• Do not blindly retry billable actions — if output is incomplete, verify state via GET /activeNumbers/{phoneNumber} (or list + filter) before retrying :rent, :rentAny, or :release.
• Never pass both config objects unnecessarily — sending empty voiceConfiguration when you only need SMS will error.
• Unlink before relinking — a number must be detached from its current service/campaign before attaching to a new one.
• campaignId is US-only — required for 10DLC, irrelevant elsewhere.
• scheduledProvisioning/scheduledVoiceProvisioning are objects (with status, lastUpdatedTime, errorCodes), not strings. Status values: PROVISIONING_STATUS_UNSPECIFIED, WAITING, IN_PROGRESS, FAILED.
• voiceConfiguration is a discriminated union on type: RTC → appId, EST → trunkId, FAX → serviceId.
• Callback config (PATCH /callbackConfiguration) sets only hmacSecret for HMAC-SHA1 signature verification — it does not set a callback URL.
• Callback IP allowlist: 54.76.19.159, 54.78.194.39, 54.155.83.128.

Links

• Numbers API docs
• Numbers API reference (Markdown)
• Numbers OpenAPI spec
• Node.js SDK Reference
• Python SDK Reference
• Java SDK Reference
• .NET SDK Reference
• LLMs.txt (full docs index)