new ExportCustomJobInstance(version, payload, resourceType)
Initialize the ExportCustomJobContext
Parameters:
| Name | Type | Description |
|---|---|---|
version |
V1 | Version of the resource |
payload |
ExportCustomJobPayload | The instance payload |
resourceType |
string | The type of communication – Messages, Calls, Conferences, and Participants |
Properties:
| Name | Type | Description |
|---|---|---|
friendlyName |
string | The friendly name specified when creating the job |
resourceType |
string | The type of communication – Messages, Calls, Conferences, and Participants |
startDay |
string | The start day for the custom export specified as a string in the format of yyyy-MM-dd |
endDay |
string | The end day for the custom export specified as a string in the format of yyyy-MM-dd. This will be the last day exported. For instance, to export a single day, choose the same day for start and end day. To export the first 4 days of July, you would set the start date to 2020-07-01 and the end date to 2020-07-04. The end date must be the UTC day before yesterday. |
webhookUrl |
string | The optional webhook url called on completion |
webhookMethod |
string | This is the method used to call the webhook |
email |
string | The optional email to send the completion notification to |
jobSid |
string | The unique job_sid returned when the custom export was created. This can be used to look up the status of the job. |
details |
object | The details of a job state which is an object that contains a `status` string, a day count integer, and list of days in the job |
jobQueuePosition |
string | This is the job position from the 1st in line. Your queue position will never increase. As jobs ahead of yours in the queue are processed, the queue position number will decrease |
estimatedCompletionTime |
string | this is the time estimated until your job is complete. This is calculated each time you request the job list. The time is calculated based on the current rate of job completion (which may vary) and your job queue position |
Methods
toJSON()
Provide a user-friendly representation
Returns:
Object