From 7a4f5832a833c1a7ee2ae6a2219cbd59feba364e Mon Sep 17 00:00:00 2001 From: isra el Date: Thu, 5 Nov 2026 14:49:27 +0300 Subject: [PATCH 1/2] docs: describe accepted recipient formats Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_017B6pTUL543EK4Ai2Aw2T12 --- README.md | 2 ++ src/types.ts | 6 +++++- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 85bc066..f6be8d5 100644 --- a/README.md +++ b/README.md @@ -180,6 +180,8 @@ It is best effort: characters with no safe equivalent pass through untouched. Ch ### Phone number helpers +textbee does not require international format. Local numbers and short codes are sent as written and reach recipients in the same country as the sending SIM. International format works for every recipient, so use these helpers when you send to more than one country or match replies to stored numbers. + ```js import { isValidE164, normalizePhoneNumber } from '@textbee/sdk' diff --git a/src/types.ts b/src/types.ts index c3b560d..0982389 100644 --- a/src/types.ts +++ b/src/types.ts @@ -18,7 +18,11 @@ export interface SendSmsRequest { /** The message body. */ message: string - /** Phone numbers to send to, in international format. */ + /** + * Phone numbers or short codes. International format (`+12025550123`) + * reaches any country. Local numbers and short codes reach recipients in + * the sending SIM's country. Values with letters are rejected with 400. + */ recipients: string[] /** From 7f6ce29be801f62a85482c5e320d72c846c89d71 Mon Sep 17 00:00:00 2001 From: isra el Date: Thu, 5 Nov 2026 14:58:14 +0300 Subject: [PATCH 2/2] docs: note that some short codes work on one carrier only Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_017B6pTUL543EK4Ai2Aw2T12 --- README.md | 2 +- src/types.ts | 5 +++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f6be8d5..8a4b1d2 100644 --- a/README.md +++ b/README.md @@ -180,7 +180,7 @@ It is best effort: characters with no safe equivalent pass through untouched. Ch ### Phone number helpers -textbee does not require international format. Local numbers and short codes are sent as written and reach recipients in the same country as the sending SIM. International format works for every recipient, so use these helpers when you send to more than one country or match replies to stored numbers. +textbee does not require international format. Local numbers are sent as written and reach recipients in the same country as the sending SIM. Short codes are sent as written too. They work only in the sending SIM's country, and some work only on one carrier. International format works for every recipient, so use these helpers when you send to more than one country or match replies to stored numbers. ```js import { isValidE164, normalizePhoneNumber } from '@textbee/sdk' diff --git a/src/types.ts b/src/types.ts index 0982389..79a5025 100644 --- a/src/types.ts +++ b/src/types.ts @@ -20,8 +20,9 @@ export interface SendSmsRequest { /** * Phone numbers or short codes. International format (`+12025550123`) - * reaches any country. Local numbers and short codes reach recipients in - * the sending SIM's country. Values with letters are rejected with 400. + * reaches any country. Local numbers reach recipients in the sending SIM's + * country. Short codes work only in that country, and some only on one + * carrier. Values with letters are rejected with 400. */ recipients: string[]