The Yay.com Application Programming Interface (API) has lots of uses: pulling down call data, managing SIP accounts or VoIP Phone numbers, reselling our Cloud PBX service into your own platform, or integrating with your own websites and systems.
While Yay.com doesn't offer extensive support for how to integrate with our API, we do have a few of links below which go through exactly how you can get started:
Access to our API is included in all of our VoIP plans, and you can access our VoIP API documentation from your online Dashboard.
As well as the API Documentation you’ll need to take a look at the API page on Your Dashboard. There you’re given your API headers that you’ll need for the API commands that you run.
In addition, you’ll need to add your IP address to the Allowed IP Ranges list. For security we don’t let anyone make API commands for an account unless it’s from an IP address listed here, so it’s important to add your own here to make sure you’re authorised to run commands.
Lastly the API page allows you to change your API password, which is also required for commands you run to authenticate properly.
If you have added your IP address and run into authentication issues we recommend checking your API password and/or whether the requests are coming from the right IP address. Some API softwares use proxies that mean that the request is not coming from an IP that you might expect, so that’s always worth checking!
If you need any further help today, please don't hesitate to contact our friendly support team on 0330 122 6000 or by email!