Dial-In-Numbers API
Dial In Numbers (DIN) are local numbers (DID) which you can subscribe and receive calls with.
By setting the parameter with any subscription of a DIN,
you can either answer an incoming call with your specified .mp3 file,
original message specified with our TTS,
transfer the call to the other number as you like or
store messages in the Voicemail.
How to use the Dial-In-Numbers API
- Search for an available number
The DIN numbers that you can subscribe to will be shown by your search. Please note thedin_uid
of your favorite number for the later use. The types of the prefix for each country that are available to subscribe from Xoxzo API can be found in the price page. - Subscribe to a DIN
Use thedin_uid
you noted in No.1, subscribe to a DIN. In case you are just trying this and do not wish to pay the full cost, please unsubscribe this number within the next 24 hours. Discounted 24 hours price will be applied to this subscription.
Now, you own a phone number. - Attach an action to the DIN
Please setaction_url
to the DIn you subscribed.
The url specified foraction_url
will be called viaGET
when there is incoming call to your subscribed DialIN number to get a command that will be used to handle the call. - Make the commands available via the action URL
The command thataction_url
must return can be selected from below.
Action | Description |
playback | Plays back an mp3 file to the caller |
transfer | Transfers the incoming call to another number |
say | Takes text and reads it out loud (Text-to-Speech) |
[voicemail](https://help.xoxzo.com/en/xoxzo-cloud-telephony/articles/how-to-use-voicemail/) | save voicemail recordings in the account |
5. Now you are ready to receive calls on the DIN and process them!!
More merit with Dial-In-Numbers API
In addition, with any Japanese number you subscribe, you can use that number even more useful, this is what the optional Local Caller ID.
By default, restrictions in Japan does not allow you to use a local number as the caller ID. Our optional local caller ID functionality through our Dial In Numbers allows you to use a local Japan number for your voice calls.
Here is how to:
- Find your favorite prefix number to subscribe
- Subscribe to the number Ref: Dial-In-Numbers API
- Enjoy calling with notifying your call receivers who is calling by using the jp optional parameter. Ref: Pricing of Voice API