Add, Edit, Delete Extension & Contact

3cx add edit delete extension contact mrvoip

Content

MRVOIP platform provides reliable Add, Edit, Delete account via HTTP API functions to help your organisation add, edit, delete extensions with just one touch. Forget about doing multiple updates on CRM, telephone directory and your PBX.

With MRVOIP Add, Edit, Delete account via HTTP API feature, you can be rest assured that our innovative ways of updating your data throughout the platforms becomes a seamless experience and maintained at the highest level of security.

This powerful feature gives users programmatic experience to access our services making use of resource-based URLs, status codes, methods (POST, DELETE, etc.), and JSON for requests and responses. This makes it easy to use HTTP clients in your backend for powerful API interaction.

MRVOIP can dive straight into creating and updating data via HTTP API and help to analyse which routes supports creation and update methods ensuring that information is fully updated across the board.

Our 3CX HTTP API allows you to add, edit and delete accounts of your 3CX clients. You can create and edit extensions on our console and send manual links, client-provisioning configuration file, and voice mail secret number. You can use a softphone to alter auto-generated authentication credentials and keep your customer records up-to-date.

Our solution allows you customize each user account so that you are able to meet unique needs of your 3CX clients. If you are looking for an effective web conferencing solution, you can specify a meeting room name so that your partners can have a personalized inbound call or a 3CX web meeting. It’s simple, effective and certainly less time-consuming than most other solutions in the marketplace.

This is introduces to Develop Mr.VoIP Tool to Add / Update / Delete Extension and Contacts through HTTP API with Security Key.

  • Uses predictable, resource-oriented URLs.
  • Uses built-in HTTP capabilities for passing parameters and authentication.
  • Responds with standard HTTP response codes to indicate errors.
  • POST JSON Object/Array.

The HTTP API gives you programmatic access to our services. We try our best to be RESTful,making use of resource-based URLs, status codes, methods (POST, DELETE, etc.), and JSON for requests and responses. This makes it easy to use HTTP clients in your backend for powerful API interaction.

Use the HTTP API to send data directly from endpoint to 3cx server. In the examples the parameters are highlighted purple. The values in yellow are what you need to replace with the parameters you are specifically interested in.

Talk to us today to find out more..

Add/Edit/Delete Extension or Contact through HTTP API

Action Description
Title Call Control Manager API
Base URL https://x5.1xx.xxx.x4:8000/api.aspx
Method POST
URL Parameter qsSecuritykey=25sdfs482s4Rsdfasxt45wersf
qsValue= Json Array
Json Array (Request Format) {
“mExtension”:[{“FirstName”: “xxxxx”,
“LastName”: “xxxx”,
“PhoneNumber”: “xxxx”,
“CompanyName”: “xxxxxx”}]
}
Success Response Format {“status”:”Extension Created”, “errorMessage”:””, “errorCode”:””}
Error Response Format {“message”:”Authentication Token invalid”,
“errorCode”:”INVALID_AUTH_ID”}

Post Request Format:

Send to POST url ( https://x5.1xx.xxx.x4:8000/api.aspx?action=addExt&qstype=1&qsValue={………} & qsSecuritykey=25sdfs482s4Rsdfasxt45wersf ) with two request parameters:

Argument Description
qsValue Either a single JSON event object or an array of JSON objects, each of which represents one event.
qsSecuritykey If Security key value matched with your external application. The POST method with proceed for request.

Add Single Extension

To Add Single Extension into 3CX Management Console

Property Description
ExtentionNumber The unique Extension number (Required)
EmailAddress Email Address of the user (Optional)
FirstName First name of the user (Required)
LastName Last Name of the user (Optional)
OutboundCallerID Outbound Caller ID of the user (Optional)

HTTP POST URL (Request Format):

https://x5.1xx.xxx.x4:8000/api.aspx?action=addExt&qstype=1&qsSecuritykey=25sdfs482s4Rsdfasxt45wersf &qsValue=
{
“sExtension”:
[ {“ExtentionNumber”:”xxxx”, “EmailAddress”:””, “FirstName”: ” xxxx “, “LastName”: “”, “OutboundCallerID”: “”}
]
}

Response Format:

If Success – {“status”:”Extension Created”, “errorMessage”:””, “errorCode”:””}

If Fails – {“message”:”Authentication Token invalid”, “errorCode”:”INVALID_AUTH_ID”}
{“message”:”Internal Server error”, “errorCode”:”500″}
{“message”:”Exception Detail”, “errorCode”:”WEBSERVICE_ERROR”}

Add Multiple Extension

To Add Multiple Extension, we can use Json array as follows.

Property Description
ExtentionNumber The unique Extension number (Required)
EmailAddress Email Address of the user (Optional)
FirstName First name of the user (Required)
LastName Last Name of the user (Optional)
OutboundCallerID Outbound Caller ID of the user (Optional)

HTTP POST URL (Request Format):

https://x5.1xx.xxx.x4:8000/api.aspx?action=addExt&qstype=1&qsSecuritykey=25sdfs482s4Rsdfasxt45wersf&qsValue=

{
“mExtension”:
[ {“ExtentionNumber”:”xxxx”, “EmailAddress”:””, “FirstName”: ” xxxx “, “LastName”: “”, “OutboundCallerID”: “”}, {“ExtentionNumber”:”xxxx”, “EmailAddress”:””, “FirstName”: ” xxxx “, “LastName”: “”, “OutboundCallerID”: “”}
]
}

Response Format:

If Success – {“status”:”All Extension Created”, “errorMessage”:””, “errorCode”:””}

If Fails – {“message”:”Authentication Token invalid”, “errorCode”:”INVALID_AUTH_ID”}

{“message”:”Internal Server error”, “errorCode”:”500″}

{“message”:”Exception Detail”, “errorCode”:” WEBSERVICE_ERROR “}

Delete Extension

To Delete an Extension

Property Description
ExtentionNumber The unique Extension number (Required)

HTTP POST URL (Request Format):

https://x5.1xx.xxx.x4:8000/api.aspx?action=deleteExt&qstype=1&qsSecuritykey=25sdfs482s4Rsdfasxt45wersf &qsValue=

{
“dExtension”:
[ {“ExtentionNumber”:”xxxx”}
]
}

Response Format:

If Success – {“status”:”Extension Deleted”, “errorMessage”:””, “errorCode”:””}

If Fails – {“message”:”Authentication Token invalid”, “errorCode”:”INVALID_AUTH_ID”}

{“message”:”Internal Server error”, “errorCode”:”500″}

{“message”:”* Exception Detail”, “errorCode”:” WEBSERVICE_ERROR “}

*Note: Exception Detail response error like (e.g: Extension number does not exit).

Update Extension

To Update the information for the specific Extension. Note: Extension number is a fixed value and it cannot be changed.

Property Description
ExtentionNumber The unique Extension number (Required)
EmailAddress Email Address of the user (Optional)
FirstName First name of the user (Required)
LastName Last Name of the user (Optional)
OutboundCallerID Outbound Caller ID of the user (Optional)

HTTP POST URL (Request Format):

https://x5.1xx.xxx.x4:8000/api.aspx?action=updateExt&qstype=1&qsSecuritykey=25sdfs482s4Rsdfasxt45wersf &qsValue=

{
“uExtension”:
[ {“ExtentionNumber”:”xxxx”, “EmailAddress”:””, “FirstName”: ” xxxx “, “LastName”: “”, “OutboundCallerID”: “”}
]
}

Response Format:

If Success – {“status”:”Extension Updated”, “errorMessage”:””, “errorCode”:””}

If Fails – {“message”:”Authentication Token invalid”, “errorCode”:”INVALID_AUTH_ID”}

{“message”:”Internal Server error”, “errorCode”:”500″}

{“message”:”Exception Detail”, “errorCode”:”WEBSERVICE_ERROR”}

Add new Contact

To Add Single Contact

Property Description
FirstName First Name of the contact person (Required)
LastName Last Name of the contact person (Required)
PhoneNumber Phone Number of the contact person (Required)
CompanyName Company Name of the contact person

HTTP POST URL (Request Format):

https://x5.1xx.xxx.x4:8000/api.aspx?action=addPhonebook&qstype=1&qsSecuritykey=25sdfs482s4Rsdfasxt45wersf &qsValue=

{
“sContact”:
[ {“FirstName”: “xxxxx”, “LastName”: “xxxx”, “PhoneNumber”: “xxxx”, “CompanyName”: “”}
]
}

Response Format:

If Success – {“status”:”Contact Created”, “errorMessage”:””, “errorCode”:””}

If Fails – {“message”:”Authentication Token invalid”, “errorCode”:”INVALID_AUTH_ID”}

{“message”:”Internal Server error”, “errorCode”:”500″}

{“message”:”Exception Detail”, “errorCode”:” WEBSERVICE_ERROR “}

Update Contact

Top Update Contact list person

Property Description
FirstName First Name of the contact person (Required)
LastName Last Name of the contact person (Required)
PhoneNumber Phone Number of the contact person (Required)
CompanyName Company Name of the contact person
Registered PhoneNumber Specific contact person Phone Number of the contact person (Required)

HTTP POST URL (Request Format):

https://x5.1xx.xxx.x4:8000/api.aspx?action=updatePhonebook&qstype=1&qsSecuritykey=25sdfs482s4Rsdfasxt45wersf &qsValue=

{
“uContact”:
[ {“FirstName”: “xxxx”, “LastName”: “xxxx”, “PhoneNumber”: “xxxx”, “CompanyName”: “”, “RegisteredPhoneNumber”: “xxxx”}
]
}

Response Format:

If Success – {“status”:”Contact Updated”, “errorMessage”:””, “errorCode”:””}

If Fails – {“message”:”Authentication Token invalid”, “errorCode”:”INVALID_AUTH_ID”}

{“message”:”Internal Server error”, “errorCode”:”500″}

{“message”:”Exception Detail”, “errorCode”:”WEBSERVICE_ERROR”}

Delete Contact

To delete a person from the contact list

Property Description
PhoneNumber Phone Number of the contact person to delete the record (Required)

HTTP POST URL (Request Format):

https://x5.1xx.xxx.x4:8000/api.aspx?action=deletePhonebook&qstype=1&qsSecuritykey=25sdfs482s4Rsdfasxt45wersf &qsValue=

{
“dContact”:
[ {“PhoneNumber”:”xxxx”}
]
}

Response Format:

If Success – {“status”:”Contact Deleted”, “errorMessage”:””, “errorCode”:””}

If Fails – {“message”:”Authentication Token invalid”, “errorCode”:”INVALID_AUTH_ID”}

{“message”:”Internal Server error”, “errorCode”:”500″}

{“message”:”Exception Detail”, “errorCode”:”WEBSERVICE_ERROR”}

Error Handling list:

– If Authentication token invalid:

{“message”:”Authentication Token invalid”, “errorCode”:”INVALID_AUTH_ID”}

– If Authentication token expired:

{“message”:”Authentication Token expired”, “errorCode”:”AUTH_ID_EXPIRED”}

– On Add Single Extension:

{“message”:”Invalid Extension number”, “errorCode”:”INVALID_EXTENSION”}
Note: If enter any empty value or illegal value(string)

{“message”:”Extension number already exist”, “errorCode”:”EXTENSION_EXIST”}

{“message”:”Invalid Email Address”, “errorCode”:”INVALID_EMAIL”}
Note: Validate the global email format and this field is not a mandatory one

{“message”:”Invalid First name”, “errorCode”:”FNAME_INVALID”}
Note: If enter any empty values as First name

– On Delete Extension

{“message”:”Invalid Extension number”, “errorCode”:”INVALID_EXTENSION”}
Note: If enter any empty values or extension not found

– On Update Extension

{“message”:”Invalid Extension number”, “errorCode”:”INVALID_EXTENSION”}
Note: If enter any empty values or extension not found

{“message”:”Invalid Email Address”, “errorCode”:”INVALID_EMAIL”}
Note: Validate the global email format and this field is not a mandatory one

– On Add New Contact

{“message”:”Invalid First name”, “errorCode”:”FNAME_INVALID”}
Note: If enter any empty values

{“message”:”Invalid Last name”, “errorCode”:”LNAME_INVALID”}
Note: If enter any empty values

{“message”:”Invalid Phone Number”, “errorCode”:”PHONE_NUMBER_INVALID”}
Note: If enter any empty values or illegal value(string)

– On Update Contact

{“message”:”Invalid First name”, “errorCode”:”FNAME_INVALID”}
Note: If enter any empty values

{“message”:”Invalid Last name”, “errorCode”:”LNAME_INVALID”}
Note: If enter any empty values

{“message”:”Invalid Phone Number”, “errorCode”:”PHONE_NUMBER_INVALID”}
Note: If enter any empty values or illegal value(string)

– Delete Contact

{“message”:”Invalid Phone Number”, “errorCode”:”PHONE_NUMBER_INVALID”}
Note: If enter any empty values or illegal value(string)

Note:

For every Add / Update Extension, email will send to the concerned email-id
(Note: If Email-id provided on create/update, email will receive)

While deleting extension call recording and Voice mail recording will automatically backup in ‘C’ drive ‘backup’ folder.

On add/update/delete, we check with security key and it authenticate for every action.

Save Security key in your application, while POST the Request send the security key as mentioned. Our system check with security key and send the Response.

The following diagram shows you that how IVR allow callers to enter part of the student/staff number and the System use it to lookup all possible matches on user database in LDAP via Mr.VoIP Tool

User Action

3cx add edit delete extension user action

Server Action

3cx add edit delete extension server action

Resources

Case Study

Price

GOT A QUESTION?

Enquiry Form








Copyright © 2018 Mr VoIp. All rights reserved.