- No monthly fees!API to integrate your own systems
URL:
https://api.myownaccount.net/v3/rest.php
All API calls must include the following three parameters:
| userId | 6 digits account ID |
| key | Account alphanumerical key |
| action | One of the API methods described below |
List of available actions:
Shows the current API version
| getApiVersion |
(no extra parameters needed) |
Usage:
https://api.myownaccount.net/v3/rest.php?userId=111111&key=a1b2c3d4e5f6&action=getApiVersion
Result:
{
"Status": "Success",
"getApiVersion": {
"Major": "3",
"Minor": "0",
"Release": "4",
"Build": "20191006",
"Version": "3.0.4 Build 20191006"
}
}
Shows general account information such as the account type and balance
| getAccountInfo |
(no extra parameters needed) |
Usage:
https://api.myownaccount.net/v3/rest.php?userId=111111&key=a1b2c3d4e5f6&action=getAccountInfo
Result:
{
"Status": "Success",
"AccountInfo":{
"AccountType": "JaFone",
"Balance": "44.42",
"Firstname": "John",
"Lastname": "Patrick",
"Quality": "1"
}
}
Sends a text message to a mobile phone
| sendSMS | journalId: a custom identification number for backward reference dnclId: the associated do not call list number [0-9] (0 = any) didNumber: the DID number from which to send the text message receiver: the mobile phone number which will receive the message message: the URL encoded text message being sent dnclOverride: override or not the do not contact list [yes|no] - optional |
Usage:
https://api.myownaccount.net/v3/rest.php?userId=111111&key=a1b2c3d4e5f6&journalId=136&dnclId=0&didNumber=4506704567&receiver=14506914040&message=hello&dnclOverride=yes&action=sendSMS
Result:
{
"Status": "Success",
"SMS": {
"Id": "922225"
}
}
Gets the text messages associated to a given DID number
| getSMS | didNumber: the DID number for which to retrieve the messages from from: the start date for which to retrieve messages (yyymmddThhmmss)- optional to: the end date for which to retrieve messages (yyymmddThhmmss) - optional limit: the maximum number of messages to retrieve - optional direction: specify 0 for outbound or 1 for inbound [0, 1] - optional |
Usage:
https://api.myownaccount.net/v3/rest.php?userId=111111&key=a1b2c3d4e5f6&action=getSMS&didNumber=4506704567&from=20200101T000000&to=20200301T235959&limit=50
Result:
{
"Status": "Success",
"SMSes": [
{
"Id": "938837",
"Date": "2020-07-16 12:34:39",
"Number": "14506914040",
"Message": "Hello, how are you",
"Direction": "0"
},
{
"Id": "938838",
"Date": "2020-07-16 12:35:05",
"Number": "14506914040",
"Message": "I am fine, thank you",
"Direction": "1"
}
]
}
Queries a number (LRN lookup) to validate its existence and gather its location, operator and line type
| getPhoneNumberInfo | number: the phone number for which to gather the info |
Usage:
https://api.myownaccount.net/v3/rest.php?userId=111111&key=a1b2c3d4e5f6&number=14506914040&action=getPhoneNumberInfo
Result:
{
"Status": "Success",
"PhoneNumberInfo": [
{
"Valid": "true",
"Number": "4506914040",
"Location": "Montreal",
"Country": "Canada",
"Country_code": "CA",
"Carrier": "Bell Mobility",
"Linetype": "wireless"
}
]
}
Manages up to 9 distincts Do Not Call lists
| setDoNotContact |
dnclId: the do not call list identifier for which the phone number will be added or removed [0-9] (0 implies all of them) number: the phone number for which to perform the do not call list operation optIn: specify 'no' to add a phone number to a list, or 'yes' to remove it [yes|NO] - optional |
Usage:
# Add a phone number to all do not call lists:
https://api.myownaccount.net/v3/rest.php?userId=111111&key=a1b2c3d4e5f6&dnclId=0&number=14506914040&optIn=no&action=setDoNotContact
# Remove a phone number from all do not call lists:
https://api.myownaccount.net/v3/rest.php?userId=111111&key=a1b2c3d4e5f6&dnclId=0&number=14506914040&optIn=yes&action=setDoNotContact
# Add a phone number to do not call lists number 2:
https://api.myownaccount.net/v3/rest.php?userId=111111&key=a1b2c3d4e5f6&dnclId=2&number=14506914040&optIn=no&action=setDoNotContact
# Remove a phone number from do not call lists number 2:
https://api.myownaccount.net/v3/rest.php?userId=111111&key=a1b2c3d4e5f6&dnclId=2&number=14506914040&optIn=yes&action=setDoNotContact
Result:
{
"Status": "Success",
"DoNotContact": {
"PhoneNumber": "5146665411"
"OptIn": "no"
}
}
Gets the list of mobile numbers that sent the keyword STOP or ARRET/ARRÊT
| getStops |
from: the date range start (yyyymmdd) - optional to: the date ranage end (yyyymmdd) - optional |
Usage:
https://api.myownaccount.net/v3/rest.php?userId=111111&key=a1b2c3d4e5f6&from=20190901&to=20190904&action=getStops
Result:
{
"Status": "Success",
"Stops": [
{
"Received": "2019-02-18 14:57:12",
"PhoneNumber": "14506914040"
},
{
"Received": "2019-02-17 15:58:13",
"PhoneNumber": "14506914141"
}
]
}
Initiates a web call that conferences two phone numbers
| createCallback |
caller: the phone number that wishes to initiate the call receiver: the destination phone number to conference in |
Usage:
https://api.myownaccount.net/v3/rest.php?userId=111111&key=a1b2c3d4e5f6&caller=14506914040&receiver=15142375460&action=createCallback
Result:
{
"Status": "Success"
}
Shows current phone numbers used for call back
| getCallBackNumbers |
(no extra parameters needed) |
Usage:
https://api.myownaccount.net/v3/rest.php?userId=111111&key=a1b2c3d4e5f6&action=getCallBackNumbers
Result:
{
"Status": "Success",
"CallbackNumbers": [
{
"Id": "1",
"PhoneNumber": "5147371111"
},
{
"Id": "2",
"PhoneNumber": "4506914040"
},
{
"Id": "3",
"PhoneNumber": "5147989999"
}
]
}
Sets a given phone number as an allowed call back number
| setCallBacknumber |
id: the phone number identifier [1-3] number: the phone number being set as one of the three allowed call back numbers |
Usage:
https://api.myownaccount.net/v3/rest.php?userId=111111&key=a1b2c3d4e5f6&&id=3&number=4506781600&action=setCallbackNumber
Result:
{
"Status": "Success",
"CallbackNumbers": [
{
"Id": "1",
"PhoneNumber": "5147371111"
},
{
"Id": "2",
"PhoneNumber": "4506914040"
},
{
"Id": "3",
"PhoneNumber": "4506781600"
}
]
}
Shows current call forwarding information
| getCallForwardingInfo |
(no extra parameters needed) |
Usage:
https://api.myownaccount.net/v3/rest.php?userId=111111&key=a1b2c3d4e5f6&action=getCallForwardingInfo
Result:
{
"Status": "Success",
"CallForwardingInfo": {
"Enabled": yes,
"PhoneNumber": "5147371111"
}
}
Sets account call forwarding settings
| setCallForwarding |
IsEnabled: specify 'yes' to enable call forwarding, otherwise 'no' to disable it [yes|no] number: the phone number for which to call forward the account |
Usage:
https://api.myownaccount.net/v3/rest.php?userId=111111&key=a1b2c3d4e5f6&isEnabled=yes&number=4506914040&action=setCallForwarding
Result:
{
"Status": "Success",
"CallForwardingInfo": {
"Enabled": yes,
"PhoneNumber": "4506914040"
}
}
Shows transactions that occurred between two specific dates
| getTransactions |
from: the date interval start for which to show transactions (yyymmdd) - optional to: the date interval end for which to show transactions (yyymmdd) - optional |
Usage:
https://api.myownaccount.net/v3/rest.php?userId=111111&key=a1b2c3d4e5f6&from=20191002&to=20191005action=getTransactions
Result:
{
"Status": "Success",
"Transactions": [
{
"Date": "2019-10-01 23:30:02",
"Description": "Frais mensuel: DID (4506702992)",
"Value": "-149500",
"Subaccount": "222222",
"Type": "6",
"PaymemtId": null
}
]
}
Shows current call routing type
| getCallRoutingType |
(no extra parameters needed) |
Usage:
https://api.myownaccount.net/v3/rest.php?userId=111111&key=a1b2c3d4e5f6&action=getCallRoutingType
Result:
{
"Status": "Success",
"CallRoutingType": [
{
"RoutingType": "1" # 0 = standard, 1= premium
}
]
}
Sets account call routing type
| setCallRoutingType |
type: specify 0 for standard or 1 for premium [0|1] |
Usage:
https://api.myownaccount.net/v3/rest.php?userId=111111&key=a1b2c3d4e5f6&type=1&action=setCallRoutingType
Result:
{
"Status": "Success",
"CallRoutingType": [
{
"RoutingType": "1"
}
]
}
Shows the current account balance
| getBalance |
(no extra parameters needed) |
Usage:
https://api.myownaccount.net/v3/rest.php?userId=111111&key=a1b2c3d4e5f6&action=getBalance
Result:
{
"Status": "Success",
"Balance": {
"Amount": "46.32"
}
}
Shows low balance alerting information
| getLowBalanceAlertInfo |
(no extra parameters needed) |
Usage:
https://api.myownaccount.net/v3/rest.php?userId=111111&key=a1b2c3d4e5f6&action=getLowBalanceAlertInfo
Result:
{
"Status": "Success",
"LowBalanceAlertInfo": {
"Enabled": "true",
"Amount": "10.00"
}
}
Set low balance alerting settings
| setLowBalanceAlert |
isEnabled: specify 'yes' to enable low balance alerting and 'no' to disable it [yes|NO] - optional amount: the amount for which an alert will be triggered, e.g. 5.00 |
Usage:
https://api.myownaccount.net/v3/rest.php?userId=111111&key=a1b2c3d4e5f6&isEnabled=yes&amount=5.00&action=setLowBalanceAlert
Result:
{
"Status": "Success",
"LowBalanceAlertInfo": {
"Enabled": "true",
"Amount": "5.00"
}
}
Shows the emails at which the voicemails are sent to
| getVoicemailEmails |
(no extra parameters needed) |
Usage:
https://api.myownaccount.net/v3/rest.php?userId=111111&key=a1b2c3d4e5f6&action=getVoicemailEmails
Result:
{
"Status": "Success",
"VoicemailEmails": {
"Emails": [
"[email protected]",
"[email protected]"
]
}
}
Sets the e-mail at which the voicemails are sent to
| setVoicemailEmails |
emails: the list of emails each separated by a comma |
Usage:
https://api.myownaccount.net/v3/rest.php?userId=111111&key=a1b2c3d4e5f6&emails=johnpatrick@gmail.com,[email protected]&action=setVoicemailEmails
Result:
{
"Status": "Success",
"VoicemailEmails": {
"Emails": [
"[email protected]",
"[email protected]"
]
}
}
Gets the list of all upcoming conference bridges
| getConferencesInfo |
(no extra parameters needed) |
Usage:
https://api.myownaccount.net/v3/rest.php?userId=111111&key=a1b2c3d4e5f6&action=getConferencesInfo
Result:
{
"Status": "Success",
"ConferencesInfo": [
{
"ConferenceNumber": "507258",
"PublicPin": "872943",
"AdminPin": "789543",
"Date": "2019-12-11",
"Duration": "60 minutes",
"WebCollaborationEnabled": "yes"
}
]
}
Schedule a conference bridge
| scheduleConference |
date: conference bridge scheduled date (yyyymmdd) duration: approximative conference duration in minutes; does not end automatically if it actually takes longer isWebCollabEnabled: give access to the web collaboration tool [yes|NO] - optional |
Usage:
https://api.myownaccount.net/v3/rest.php?userId=111111&key=a1b2c3d4e5f6&date=20201008&duration=120&isWebCollabEnabled=yes&action=scheduleConference
Result:
{
"Status": "Success",
"ConferencesInfo": [
{
"ConferenceNumber": "090482",
"PublicPin": "287355",
"AdminPin": "784783",
"Date": "2019-11-21",
"Duration": "180 minutes",
"WebCollaborationEnabled": "yes"
}
]
}
Gets the list of contacts currently available in the account
| getContacts |
(no extra parameters needed) |
Usage:
https://api.myownaccount.net/v3/rest.php?userId=111111&key=a1b2c3d4e5f6&action=getContacts
Result:
{
"Status": "Success",
"Contacts": [
{
"SpeedDial": "4",
"Prefix": "1",
"PhoneNumber": "4506914040",
"Name": "John Patrick"
}
]
}
Initiate a text-to-speech call
| createTtsCallSvt |
msgId: the Servatus message identifier number: the phone number to call lang: the spoken language to use, 'fr' for French and 'en' for english [fr|EN] cbRetries: the number of times to retry when the number does not answer [0-10] cbInterval: the number of minutes in between retries when the number does not answer [1-1440] cbBusyRetries: the number of times to retry when the number is busy [0-10] cbBusyInterval: the number of minutes in between retries when the number is busy [1-1440] ...placeholder values: placeholders' values presented in the Servatus message (e.g. #FN) |
Usage:
https://api.myownaccount.net/v3/rest.php?userId=111111&key=a1b2c3d4e5f6&action=createTtsCallSvt&msgId=123456&number=14506914040&lang=en&
cbRetries=2&cdInterval=15&cbBusyRetries=2&cbBusyInterval=15&FN=Patrick&BL=100
Result:
{
"Status": "Success",
"TtsCall": [
{
"PreparedMessage": "Hello Patrick, your account balance is now 100 dollars. Thank you, goodbye.",
"PhoneNumber": "14506914040",
"CallbackRetries": "2",
"RetriesInterval": "15"
"CallbackRetriesWhenBusy": "2",
"RetriesWhenBusyInterval": "15"
}
]
}
