Skip to main content

API Endpoints and Data Residency

PaaSoo provides SMS, MMS, and Voice services across multiple regions worldwide. Dashboards, API credentials, and business data are isolated between regions.

This page describes the access information for each region. Here, "region" refers to the region of the PaaSoo contracting entity (PaaSoo Entity) that your company has signed with—not the location of the numbers you send messages to or call. Regardless of the destination country or region, always use the access information for your contracted region.

Quick Start: Find Your Access Information​

  1. Confirm your contracted region Your region is determined by the PaaSoo entity named in your contract. If you are unsure, you can:

    • Check the contracting entity in your agreement;
    • Ask your Account Manager, or contact our technical support team at support@paasoo.com.
  2. In the Regional Quick Reference, find your region's Dashboard URL and the API Base URLs for SMS / MMS and Voice. In some regions, SMS / MMS and Voice use different Base URLs. Configure them separately for each product.

  3. Log in to your region's Dashboard to obtain your API Key and API Secret. The same API Key and API Secret work for both SMS / MMS and Voice in your region. See Obtaining API Credentials for details.

Go by your contracted region, not the API domain

Always obtain your API Key and API Secret, and view your message and call records, in the Dashboard for your contracted region—regardless of the domain of the API endpoint you call.

In some regions, the API endpoint domain does not match the Dashboard domain. For example:

  • The Voice endpoint for the India region is api.paasoo.com, but the API Key and API Secret are obtained from client.paasoo.in, and Voice call records are also viewed there.
  • The SMS / MMS endpoint for the Japan region is api.paasoo.com, but the API Key, API Secret, and message records are all in client.paasoo.jp.

Do not log in to the Singapore Dashboard (client.paasoo.com) just because your API endpoint is api.paasoo.com.


1. Regional Quick Reference​

RegionDashboardSMS / MMS API Base URLVoice API Base URL
Singapore (Global, default)client.paasoo.comhttps://api.paasoo.comhttps://api.paasoo.com
Europeclient.paasoo.euhttps://api.paasoo.euhttps://api.paasoo.eu
Mainland Chinaclient.paasoo.cnhttps://api.paasoo.cnhttps://api.paasoo.cn
Indiaclient.paasoo.inhttps://api.paasoo.inhttps://api.paasoo.com
Hong Kongclient.paasoo.hkhttps://api.paasoo.hkhttps://api.paasoo.com
Japanclient.paasoo.jphttps://api.paasoo.comhttps://api.paasoo.jp
Taiwanclient.paasoo.com.twhttps://api.paasoo.com.twhttps://api.paasoo.com
Before you use this table
  • All regions support SMS, MMS, and Voice.
  • In the India, Hong Kong, Japan, and Taiwan regions, SMS / MMS and Voice use different Base URLs. Configure the Base URL separately for each product.
  • Your endpoints depend only on your contracted region, not on the destination of your messages or calls. For example, a customer contracted with the Hong Kong entity who sends SMS to Japanese numbers should call api.paasoo.hk and check delivery status in client.paasoo.hk.

2. Data Storage Locations​

SMS / MMS data and Voice data are stored in different locations. If your business has data storage requirements, refer to the table below.

RegionSMS / MMS Data LocationVoice Data Location
Singapore (Global)SingaporeSingapore
EuropeIrelandSingapore
Mainland ChinaBeijing, ChinaSingapore
IndiaMumbai, IndiaSingapore
Hong KongHong KongSingapore
JapanSingaporeSingapore
TaiwanSingaporeSingapore
Important notes on data residency
  • SMS / MMS data residency: In the Europe, Mainland China, India, and Hong Kong regions, SMS / MMS data is stored locally. The Europe region suits businesses that must keep data within the EU, such as those subject to GDPR. SMS / MMS data for the Japan and Taiwan regions is stored in Singapore; local data residency is not available.
  • All Voice data is stored in Singapore. Voice does not currently offer local storage. Regardless of your contracted region, Voice data is stored in Singapore.
  • Cross-border communications are outside the scope of data residency. When you send messages or place calls to numbers in other countries or regions, the content is transmitted over local and international carrier networks. This transmission is not covered by data residency.
  • A local region does not guarantee full compliance. A local region helps you meet data storage location requirements, but you remain responsible for assessing other compliance obligations based on your use case.
  • Confirm residency requirements before signing. Your region is determined by your contracting entity. If you have data residency requirements, confirm the appropriate entity with your Account Manager during contracting.

3. Obtaining API Credentials​

Your API credentials consist of two parts—an API Key and an API Secret. Do not mix them up.

NamePurposeHandling
API KeyIdentifies your account; maps to the key parameterVisible in the Dashboard, but should not be shared publicly
API SecretAuthenticates your requests; maps to the secret parameterStrictly confidential. Store on the server side only

Steps:

  1. Open the Dashboard for your contracted region (see the Regional Quick Reference), for example client.paasoo.com for Singapore.
  2. Log in with your account.
  3. Go to the Telecom Services module.
  4. Copy your API Key and API Secret, and use them as the key and secret parameters respectively.
  5. Keep your API Secret safe. If it is lost or you suspect it has been compromised, reset it in the Dashboard.
Credential scope
  • One API Key and API Secret pair works for both SMS / MMS and Voice in your contracted region.
  • Use your credentials only with the API endpoints listed for your contracted region and the corresponding product. Do not use them with endpoints of other regions.

4. Making Your First Request​

Request URL structure​

A complete request URL consists of three parts:

ComponentExampleDescription
Regional Base URLhttps://api.paasoo.comChoose the endpoint for your contracted region and the product you are using from the Regional Quick Reference
PathSMS: /json
Voice (TTS): /voice/tts
Depends on the API. /json returns results in JSON format
Parameters?key=...&secret=...&to=...Authentication and business parameters

Example 1: Send an SMS​

This example uses the Singapore (Global) region, whose SMS / MMS Base URL is https://api.paasoo.com.

curl -G "https://api.paasoo.com/json" \
--data-urlencode "key=YOUR_API_KEY" \
--data-urlencode "secret=YOUR_API_SECRET" \
--data-urlencode "from=YOUR_SENDER_ID" \
--data-urlencode "to=YOUR_PHONE_NUMBER" \
--data-urlencode "text=This is a test message"
  • -G appends the parameters to the URL and sends the request as a GET.
  • --data-urlencode URL-encodes parameter values automatically, so you don't need to encode spaces or special characters in the message text yourself.
  • Replace the placeholders with your own values: YOUR_API_KEY with your API Key, and YOUR_API_SECRET with your API Secret.

Parameters:

ParameterDescription
keyYour API Key, obtained from your contracted region's Dashboard
secretYour API Secret, obtained from your contracted region's Dashboard
fromSender ID. Replace with an approved Sender ID
toRecipient's mobile number in international format, including the country code, without +. Example: for the US number (201) 555-0123, use 12015550123. Replace with a valid test number
textMessage content

For the full list of parameters, responses, and error codes, see the SMS API documentation.

Example 2: Place a Voice TTS call​

Voice TTS (text-to-speech) converts text into speech, calls the recipient, and plays the message.

This example uses the Singapore (Global) region, whose Voice Base URL is https://api.paasoo.com. If you are contracted with the India, Hong Kong, Japan, or Taiwan region, replace the Base URL with the Voice API Base URL listed in the quick reference.

curl -G "https://api.paasoo.com/voice/tts" \
--data-urlencode "key=YOUR_API_KEY" \
--data-urlencode "secret=YOUR_API_SECRET" \
--data-urlencode "from=YOUR_CALLER_ID" \
--data-urlencode "to=YOUR_PHONE_NUMBER" \
--data-urlencode "lang=en-GB" \
--data-urlencode "text=Your code 1,2,3,4,5" \
--data-urlencode "repeat=2"

Parameters:

ParameterDescription
keyYour API Key. The same credentials as for SMS
secretYour API Secret. The same credentials as for SMS
fromCaller ID (the number displayed to the recipient), in international format without +. See the Voice API documentation for requirements
toRecipient's phone number, in the same format as to for SMS. Example: 12015550123. Replace with a valid test number
langPlayback language, for example en-GB (British English). See the Voice API documentation for supported languages
textText to be read aloud
repeatNumber of times the message is repeated

For the full list of parameters, responses, and error codes, see the Global Voice API documentation.

Changing your contracted region​

If your contracting entity changes, update the SMS / MMS and Voice Base URLs separately according to the quick reference, and switch to the API Key and API Secret from your new region's Dashboard.

Choose endpoints by contracted region

Choose your endpoints based on your contracted region and the product you are using, not on the destination of your messages or calls.

Protect your API Secret

Both the SMS and Voice APIs currently use GET requests, so your API Key and API Secret are passed as URL parameters and may be recorded by proxy servers or server logs.

  • Call the API from your server only. Never embed your API Key or API Secret in client-side code such as web pages or mobile apps.
  • Never commit your API Key or API Secret to a code repository or write them to public logs.
  • If you suspect your API Secret has been compromised, reset it in the Dashboard immediately and update your server configuration.

5. Product Notes​

SMS / MMS​

  • All regions support SMS / MMS. See the Regional Quick Reference for endpoints.
  • The SMS / MMS endpoint for the Japan region is api.paasoo.com, but credentials and message records are both in client.paasoo.jp.
  • For data storage locations, see Data Storage Locations.

Voice​

  • All regions support Voice.
  • The Voice endpoint for the India, Hong Kong, and Taiwan regions is api.paasoo.com, and for the Japan region it is api.paasoo.jp. Credentials and call records are still in the Dashboard for your contracted region.
  • All Voice data is stored in Singapore; local storage is not available. If you have local storage requirements for Voice data, contact your Account Manager.
  • For product details, see the Global Voice API.

6. FAQ​

I don't know which region my company is contracted with. What should I do?

Check the contracting entity in your agreement, or ask your Account Manager. You can also contact our technical support team at support@paasoo.com.

Which endpoint should I use to message or call numbers in other countries?

Use the API endpoint and Dashboard for your contracted region and the corresponding product, regardless of the destination. For example, a customer contracted with the Hong Kong entity should use api.paasoo.hk and check delivery status in client.paasoo.hk, even when sending SMS to Japanese numbers.

Why do SMS and Voice use different API endpoints for my region?

In the India, Hong Kong, Japan, and Taiwan regions, SMS / MMS and Voice use different Base URLs. Configure each according to the quick reference. Both products use the same API Key and API Secret, and all message and call records are in your contracted region's Dashboard.

My Voice endpoint is api.paasoo.com. Do I need to get credentials from client.paasoo.com?

No. Always obtain your API Key and API Secret from your contracted region's Dashboard. For example, India-region customers call the Voice API at api.paasoo.com, but obtain their credentials and view call records in client.paasoo.in.

The API returns an authentication error. What should I check?

Check the following in order:

  1. Your API Key and API Secret were obtained from your contracted region's Dashboard.
  2. The request URL is the endpoint listed for your contracted region and the product you are using. In regions where SMS and Voice use different endpoints, make sure you haven't mixed them up.
  3. Your API Key and API Secret were copied completely, with no leading or trailing spaces.

If the issue persists, contact our technical support team at support@paasoo.com.

My message was sent successfully, but I can't find the record in the Dashboard.

Check the Dashboard for your contracted region, not the one matching the API domain. For example, Voice calls placed by an India-region customer via api.paasoo.com are recorded in client.paasoo.in.

Support

If you encounter any technical issues or have business inquiries during the API integration, please do not hesitate to contact our Support team at support@paasoo.com. We are always here to assist you.