vlab:o2g:examples
Table of Contents
O2G Examples
Get a user information (subscriber)
- Send a GET request to
"https://o2g-vlab10.ale-dspp.com/api/rest/1.0/pbxs/1/instances/Subscriber/###/"
Result:
{ "objectName": "Subscriber", "objectId": "###", "attributes": [ { "name": "ACD_Group_Directory_Number", "value": [ "" ] }, { "name": "ACD_Type", "value": [ "No_ACD" ] }, { "name": "Annu_First_Name", "value": [ "" ] }, { "name": "Annu_Name", "value": [ "SIP EXT" ] }, { "name": "Associated_Dect", "value": [ "" ] }, { "name": "Associated_RSI", "value": [ "" ] }, { "name": "Associated_Station_Directory_Number", "value": [ "###" ] }, { "name": "Associated_Videophone", "value": [ "false" ] }, { "name": "Attached_MultiTandem" }, { "name": "CTQ_RA_Type", "value": [ "CTQ_NOK_TO_OK" ] }, { "name": "Call_Announce_Group", "value": [ "-1" ] }, { "name": "Call_By_Name_Mini_Messaging_Right", "value": [ "No" ] }, { "name": "Call_Conference_Group", "value": [ "-1" ] }, { "name": "Call_Priority", "value": [ "0" ] }, { "name": "Caller_Category", "value": [ "4" ] }, { "name": "ClickAndPh", "value": [ "Not_A4980" ] }, { "name": "Connection_Category_Id", "value": [ "0" ] }, { "name": "Cost_Center_Id", "value": [ "255" ] }, { "name": "Cost_Center_Name", "value": [ "" ] }, { "name": "Destination_Node", "value": [ "1" ] }, { "name": "Dialled_Number_Masked_In_Ticket", "value": [ "No" ] }, { "name": "Directory_Number", "value": [ "###" ] }, { "name": "Display_Name", "value": [ "SIP EXT ###" ] }, { "name": "Domain_Identifier", "value": [ "0" ] }, { "name": "Entity_Number", "value": [ "1" ] }, { "name": "Equipment_Address_Board", "value": [ "255" ] }, { "name": "Equipment_Address_Rack", "value": [ "255" ] }, { "name": "Equipment_Address_Terminal", "value": [ "255" ] }, { "name": "Explicit_Prio.Priority_Level", "value": [ "0" ] }, { "name": "Explicit_Prio.Priority_Mode", "value": [ "0" ] }, { "name": "External_Forwarding_Category_Id", "value": [ "255" ] }, { "name": "Facility_Category_Id", "value": [ "0" ] }, { "name": "Function", "value": [ "Administrative" ] }, { "name": "GFU_Incoming_Access", "value": [ "false" ] }, { "name": "GFU_List_Number", "value": [ "-1" ] }, { "name": "GFU_Outgoing_Access", "value": [ "false" ] }, { "name": "GFU_Preferential", "value": [ "-1" ] }, { "name": "Implicit_Prio.Priority_Level", "value": [ "0" ] }, { "name": "Implicit_Prio.Priority_Mode", "value": [ "0" ] }, { "name": "Ith_Service_Type", "value": [ "No_Valide" ] }, { "name": "Key_Profile", "value": [ "None" ] }, { "name": "Language_Id", "value": [ "1" ] }, { "name": "Metering_Category", "value": [ "Justified" ] }, { "name": "Msg_Class_nb", "value": [ "7" ] }, { "name": "Multi_Line_Facility.Delay_Overflow_For_Waiting_Call", "value": [ "false" ] }, { "name": "Multi_Line_Facility.Immediate_Overflow_For_Waiting_Call", "value": [ "false" ] }, { "name": "Multi_Line_Facility.MLA_Automatic_Outgoing_Seize", "value": [ "false" ] }, { "name": "Multi_Line_Facility.Multine_Automatic_Incoming_Seize", "value": [ "true" ] }, { "name": "Multi_Line_Facility.Multine_Automatic_Outgoing_Seize", "value": [ "true" ] }, { "name": "Multi_Line_Facility.Multine_Selective_Filtering", "value": [ "false" ] }, { "name": "Multi_Line_Facility.ake_Supervision_Off_Hook", "value": [ "false" ] }, { "name": "Multi_Line_Station", "value": [ "Yes" ] }, { "name": "Nb_Error_CodAffaire", "value": [ "0" ] }, { "name": "Nb_Error_CodSecret", "value": [ "0" ] }, { "name": "Number_Of_Users", "value": [ "1" ] }, { "name": "Occupation_Type", "value": [ "Normal" ] }, { "name": "Ope_Cca", "value": [ "false" ] }, { "name": "PCBT_Associated", "value": [ "No" ] }, { "name": "PIN.Pin_Group", "value": [ "1" ] }, { "name": "PIN.Pin_Number", "value": [ "" ] }, { "name": "PIN.Pin_Type_Of_Control", "value": [ "PIN_Category" ] }, { "name": "PIN.With_Secret_Code", "value": [ "true" ] }, { "name": "Paging_Beeper_Directory_Number", "value": [ "" ] }, { "name": "Paging_Trunk_Group_Number", "value": [ "255" ] }, { "name": "Phone_Book_First_Name", "value": [ "" ] }, { "name": "Phone_Book_Name", "value": [ "SIP EXT ###" ] }, { "name": "Pickup_Group_Name", "value": [ "" ] }, { "name": "Pin_Group_Control", "value": [ "No_Group_Access" ] }, { "name": "Primary_Line_Prio", "value": [ "No" ] }, { "name": "Prio_Presentation", "value": [ "No" ] }, { "name": "Profile_Type", "value": [ "Profile_Normal" ] }, { "name": "Public_Network_Category_Id", "value": [ "2" ] }, { "name": "Reserved_Time_Slot", "value": [ "false" ] }, { "name": "Right_Profile_Name", "value": [ "" ] }, { "name": "Robinet_Category", "value": [ "0" ] }, { "name": "Robinet_Right", "value": [ "0" ] }, { "name": "Routing_Number", "value": [ "0" ] }, { "name": "SIP_Authentification_Login", "value": [ "###" ] }, { "name": "SIP_Passwd", "value": [ "0000" ] }, { "name": "Secondary_Line_Prio", "value": [ "No" ] }, { "name": "Secret_Code", "value": [ "0000" ] }, { "name": "Secret_Code_Access_For_SUU", "value": [ "No" ] }, { "name": "Secretary_Directory_Number", "value": [ "###" ] }, { "name": "Set_Role", "value": [ "Default" ] }, { "name": "Station_Group_Directory_Number", "value": [ "" ] }, { "name": "Station_Type", "value": [ "SIP_Extension" ] }, { "name": "Supplementary_Service_Right.Display_Ext_Calling", "value": [ "true" ] }, { "name": "Supplementary_Service_Right.External", "value": [ "true" ] }, { "name": "Supplementary_Service_Right.Internal", "value": [ "true" ] }, { "name": "TAPIPremiumServer", "value": [ "No" ] }, { "name": "Tandem.Partial_Occ", "value": [ "false" ] }, { "name": "Tandem.Ringing_In_Partial_Occ", "value": [ "Long_Ring" ] }, { "name": "Tandem.Specific_Supervision", "value": [ "false" ] }, { "name": "Tandem.Tandem_Directory_Number", "value": [ "" ] }, { "name": "Tandem.Tandem_Principal", "value": [ "false" ] }, { "name": "Tele_Marketing_Actor", "value": [ "false" ] }, { "name": "Teleservice", "value": [ "Phone" ] }, { "name": "Teleservice_Incident", "value": [ "No" ] }, { "name": "Text_MSG_Number", "value": [ "8" ] }, { "name": "Transparency_VSI", "value": [ "false" ] }, { "name": "Type_of_Keyboard", "value": [ "DEFAULT_KB" ] }, { "name": "URL_Domain", "value": [ "oxe-vlab10" ] }, { "name": "URL_UserName", "value": [ "###" ] }, { "name": "UTF8_Comment1", "value": [ "" ] }, { "name": "UTF8_Comment2", "value": [ "" ] }, { "name": "UTF8_Comment3", "value": [ "" ] }, { "name": "UTF8_Comment4", "value": [ "" ] }, { "name": "UTF8_Phone_Book_First_Name", "value": [ "" ] }, { "name": "UTF8_Phone_Book_Name", "value": [ "" ] }, { "name": "Urgent_Call", "value": [ "No" ] }, { "name": "Use_Private_Calling_Number", "value": [ "false" ] }, { "name": "VIP", "value": [ "false" ] }, { "name": "Valid_For_Call_By_Name", "value": [ "Yes" ] }, { "name": "Voice_Mail_Directory_Number", "value": [ "" ] }, { "name": "Voice_Mail_Type", "value": [ "No_Mevo" ] }, { "name": "Z_ivr", "value": [ "false" ] }, { "name": "videosupportprofile", "value": [ "notsupported" ] } ], "objectNames": [ "Network_Supervisor_Mevo", "Subscriber_Alias", "Noe_Parameters", "Subscriber_Repertory", "Network_Supervisor", "IP_Extension_SIP", "Seplos_Parameters", "Subscriber_Profile", "Subscriber_Extension", "Subscriber_Keyboard", "Remote_Extension", "Dynamic_State_Subscriber", "Subscriber_Associated_Sets", "Dect_Station", "Tsc_IP_subscriber" ] }
Change the SIP Password of a user
- Sent a PUT request to https://o2g-vlab10.ale-aapp.com/api/rest/1.0/pbxs/1/instances/Subscriber/###/
You will need to send some JSON information as per the example below:
{ "attributes": [ { "name": "SIP_Passwd", "value": [ "1234" ] } ] }
vlab/o2g/examples.txt · Last modified: 2021/10/08 15:28 by admin