Teleoh™ Cloud API Docs

 Home / Teleoh™ Cloud API Docs / Application

Application

  • Create
  • GetAll
  • Get
  • Modify
  • Delete



  • Create

    Create a new VoiceAPI.cloud application. After creating an application you can point incoming numbers or outbound calls here.

    POST/GET http://voiceapi.cloud/API/{format}/Application/Create
    

    Parameter Description Required
    API_USER_ID Your API user ID YES
    API_KEY Your API key YES
    app_name A unique name for your application. YES
    answer_url The cloud will request this URL looking for a valid XML on an incoming call. YES
    answer_method The method used to request the answer_url (POST or GET) YES
    hangup_url The URL the cloud will notify when a call is disconnected.
    hangup_method The method used to notify the hangup_url (POST or GET)
    message_url The URL the cloud will notify when a incoming SMS is received.
    message_method The method used to notify the message_url (POST or GET).

    JSON Response
    {
        "application": {
            "app_id": {},
            "app_name": "Demo Application",
            "answer_url": "http:\/\/myurl.com\/demo\/demo.php",
            "answer_method": "POST",
            "hangup_url": "http:\/\/myurl.com\/hangup.php",
            "hangup_method": "POST",
            "message_url": "http:\/\/myurl.com\/message.php",
            "message_method": "POST"
        }
    }
    

    XML Response
    <?xml version="1.0" encoding="UTF-8"?>
    <heg>
       <application>
          <app_id />
          <app_name>Demo Application</app_name>
          <answer_url>http://myurl.com/demo/demo.php</answer_url>
          <answer_method>POST</answer_method>
          <hangup_url>http://myurl.com/hangup.php</hangup_url>
          <hangup_method>POST</hangup_method>
          <message_url>http://myurl.com/message.php</message_url>
          <message_method>POST</message_method>
       </application>
    </heg>
    


    GetAll

    Get a list of all applications linked to your account.

    POST/GET http://voiceapi.cloud/API/{format}/Application/GetAll
    

    Parameter Description Required
    API_USER_ID Your API user ID YES
    API_KEY Your API key YES

    JSON Response
    {
        "application": [{
            "app_id": "8",
            "app_name": "First Application ",
            "answer_url": "http:\/\/voiceapi.cloud\/customertest.php",
            "answer_method": "POST",
            "hangup_url": "http:\/\/mywebsite.com\/hangup.asp",
            "hangup_method": "POST",
            "message_url": "http:\/\/mywebsite.com\/message.asp",
            "message_method": "POST"
        }, {
            "app_id": "13",
            "app_name": "Demo Application",
            "answer_url": "http:\/\/myurl.com\/demo\/demo.php",
            "answer_method": "POST",
            "hangup_url": "http:\/\/myurl.com\/hangup.php",
            "hangup_method": "POST",
            "message_url": "http:\/\/myurl.com\/message.php",
            "message_method": "POST"
        }]
    }
    

    XML Response
    <?xml version="1.0" encoding="UTF-8"?>
    <heg>
       <application>
          <app_id>8</app_id>
          <app_name>First Application</app_name>
          <answer_url>http://voiceapi.cloud/customertest.php</answer_url>
          <answer_method>POST</answer_method>
          <hangup_url>http://mywebsite.com/hangup.asp</hangup_url>
          <hangup_method>POST</hangup_method>
          <message_url>http://mywebsite.com/message.asp</message_url>
          <message_method>POST</message_method>
       </application>
       <application>
          <app_id>13</app_id>
          <app_name>Demo Application</app_name>
          <answer_url>http://myurl.com/demo/demo.php</answer_url>
          <answer_method>POST</answer_method>
          <hangup_url>http://myurl.com/hangup.php</hangup_url>
          <hangup_method>POST</hangup_method>
          <message_url>http://myurl.com/message.php</message_url>
          <message_method>POST</message_method>
       </application>
    </heg>
    
    


    Get

    Get the details of a specific application.

    POST/GET http://voiceapi.cloud/API/{format}/Application/Get
    

    Parameter Description Required
    API_USER_ID Your API user ID YES
    API_KEY Your API key YES
    app_id The ID of the application for which your requesting the details. YES

    JSON Response
    {
        "application": {
            "app_id": {},
            "app_name": "First Application ",
            "answer_url": "http:\/\/mywebsite.com\/answer.php",
            "answer_method": "POST",
            "hangup_url": "http:\/\/mywebsite.com\/hangup.asp",
            "hangup_method": "POST",
            "message_url": "http:\/\/mywebsite.com\/message.asp",
            "message_method": "POST"
        }
    }
    

    XML Response
    <?xml version="1.0" encoding="UTF-8"?>
    <heg>
       <application>
          <app_id />
          <app_name>First Application</app_name>
          <answer_url>http://mywebsite.com/answer.asp</answer_url>
          <answer_method>POST</answer_method>
          <hangup_url>http://mywebsite.com/hangup.asp</hangup_url>
          <hangup_method>POST</hangup_method>
          <message_url>http://mywebsite.com/message.asp</message_url>
          <message_method>POST</message_method>
       </application>
    </heg>
    


    Modify

    Modify a application. Only parameters passed will be updated. Outside of app_id no parameter is required.

    POST/GET http://voiceapi.cloud/API/{format}/Application/Modify
    

    Parameter Description Required
    API_USER_ID Your API user ID YES
    API_KEY Your API key YES
    app_id The ID of the application for which you want to modify. YES
    app_name A unique name for your application.
    answer_url The cloud will request this URL looking for a valid XML on an incoming call.
    answer_method The method used to request the answer_url (POST or GET)
    hangup_url The URL the cloud will notify when a call is disconnected.
    hangup_method The method used to notify the hangup_url (POST or GET)
    message_url The URL the cloud will notify when a incoming SMS is received.
    message_method The method used to notify the message_url (POST or GET).

    JSON Response
    {
        "application": {
            "app_id": {},
            "app_name": "First Application ",
            "answer_url": "http:\/\/mywebsite.com\/answer.php",
            "answer_method": "POST",
            "hangup_url": "http:\/\/mywebsite.com\/hangup.asp",
            "hangup_method": "POST",
            "message_url": "http:\/\/mywebsite.com\/message.asp",
            "message_method": "POST"
        }
    }
    

    XML Response
    <?xml version="1.0" encoding="UTF-8"?>
    <heg>
       <application>
          <app_id />
          <app_name>First Application</app_name>
          <answer_url>http://mywebsite.com/answer.asp</answer_url>
          <answer_method>POST</answer_method>
          <hangup_url>http://mywebsite.com/hangup.asp</hangup_url>
          <hangup_method>POST</hangup_method>
          <message_url>http://mywebsite.com/message.asp</message_url>
          <message_method>POST</message_method>
       </application>
    </heg>
    


    Delete

    Delete a application.

    POST/GET http://voiceapi.cloud/API/{format}/Application/Delete
    

    Parameter Description Required
    API_USER_ID Your API user ID YES
    API_KEY Your API key YES

    JSON Response
    {
        "application": {
            "app_id": "12"
        }
    }
    

    XML Response
    <?xml version="1.0" encoding="UTF-8"?>
    <heg>
       <application>
          <app_id>12</app_id>
       </application>
    </heg>