v1

latestOpenAPI 3.0.3RingCentral API License Agreement2026-08-064871,2921.5 MB

External Contacts

Get Contacts Upload Task

Returns the status of a task on adding multiple contacts to multiple extensions.

get/restapi/v1.0/account/{accountId}/address-book-bulk-upload/tasks/{taskId}

Path parameters

accountIdstring required

Internal identifier of the RingCentral account (can be set to "~" to indicate that the account associated with current authorization session should be used)

taskIdstring required

Internal identifier of a task

Response

Contacts upload task

idstring required

Internal identifier of a task

uristring uri required

Link for the task status retrieval

status'Accepted' | 'InProgress' | 'Completed' | 'Failed' required

Task status

creationTimestring date-time required

Date/time of a task creation

lastModifiedTimestring date-time required

Date/time of a task latest update

Example response

{
  "results": {
    "affectedItems": [
      {
        "contacts": [
          {
            "email": "charlie.williams@example.com",
            "notes": "#1 Customer",
            "company": "Example, Inc.",
            "firstName": "Charlie",
            "lastName": "Williams",
            "jobTitle": "CEO",
            "webPage": "http://www.example.com",
            "middleName": "J",
            "nickName": "The Boss",
            "email2": "charlie-example@gmail.com",
            "email3": "theboss-example@hotmail.com",
            "homePhone": "+15551234567",
            "homePhone2": "+15551234567",
            "businessPhone": "+15551234567",
            "businessPhone2": "+15551234567",
            "mobilePhone": "+15551234567",
            "businessFax": "+15551234567",
            "companyPhone": "+15551234567",
            "assistantPhone": "+15551234567",
            "carPhone": "+15551234567",
            "otherPhone": "+15551234567",
            "otherFax": "+15551234567",
            "callbackPhone": "+15551234567"
          }
        ]
      }
    ]
  }
}