Yeastar P-Series
Overview
FutureSMS can be configured as a custom SMS service provider for Yeastar P-Series Omnichannel Messaging. Yeastar stays the PBX-side user interface; FutureSMS provides the authentication key, send URL, verification URL, configured sender, and SMS delivery pipeline.
Use Yeastar's official documentation for PBX-side screens and field names. Use this page to understand what FutureSMS expects and returns.
Before You Begin
Prepare a Yeastar P-Series environment that supports custom SMS service provider configuration, and choose the FutureSMS sender that should be used for Yeastar-originated messages.
Configure the PBX-side fields by following Yeastar's official guide, then use this page to understand the FutureSMS-side contract and expected request behavior.
What FutureSMS Provides
| Value | Purpose |
|---|---|
| Yeastar API key | Dedicated Bearer API key for Yeastar requests. |
| Send Message URL | Yeastar calls this URL when a user sends an SMS. |
| Authentication Verification URL | Yeastar can call this URL to verify the API key. |
| Configured sender | FutureSMS sender identity linked to the Yeastar configuration. |
FutureSMS Endpoints
| Method | Path | Purpose |
|---|---|---|
GET | /api/v1/integration/yeastar/sms/verify | Authentication verification URL. |
POST | /api/v1/integration/yeastar/sms/sendmessage | Send message URL. |
Both endpoints use Authorization: Bearer {api_key}.
Request Flow
- Yeastar verifies the configured API key if verification is enabled.
- A Yeastar user sends an SMS from a configured channel.
- Yeastar posts
from,to, andtextto the FutureSMS send-message URL. - FutureSMS resolves the configured sender for the request.
- FutureSMS validates the account, recipient, sender, and SMS content.
- FutureSMS creates an SMS order and returns the order id to Yeastar as
data.id.
Send Message Request
| Field | Type | Required | Rules |
|---|---|---|---|
from | string | Yes | Yeastar sender phone number in E.164 format. |
to | string | Yes | Recipient phone number in E.164 format. |
text | string or null | No | SMS text content, max 2000 chars before FutureSMS validation. |
media_urls | string array or null | No | MMS media URLs; not supported. |
FutureSMS sends outbound SMS text only. media_urls is rejected.
Supported Scope
The Yeastar integration is for outbound SMS from Yeastar through a configured FutureSMS sender. It does not expose arbitrary sender selection to Yeastar, and it does not turn the Merchant API token flow into a Yeastar credential. Yeastar uses the dedicated Yeastar API key.
Status codes
Yeastar integration endpoints return Yeastar-compatible errors instead of the Merchant API error envelope.
| HTTP status | Code | Title | Typical meaning in this integration |
|---|---|---|---|
400 | 10001 | Invalid phone number | from or to is not a usable SMS phone number. |
400 | 10002 | Invalid parameter | Required text or request fields are missing or invalid. |
400 | 10003 | Unsupported media | media_urls was provided, but this integration sends SMS text only. |
401 | 10004 | Authentication failed | The Yeastar API key is missing or invalid. |
403 | 10005 | No permission | The configured sender, account, or integration setup cannot send this message. |
429 | 10006 | Too many requests | Requests are arriving faster than the integration should process. |
500 | 10007 | Service unavailable | The message could not be accepted because the service is temporarily unavailable. |
Examples
{
"from": "+630000000001",
"to": "+639171234567",
"text": "Hello from Yeastar"
}
{
"data": {
"id": "SDPS260325103012A1B2C3D"
}
}
{
"errors": [
{
"code": "10005",
"title": "No permission",
"detail": "No permission"
}
]
}