components: schemas: bulkexports.v1.export: properties: links: description: Nested resource URLs. nullable: true type: object resource_type: description: "The type of communication \u2013 Messages, Calls, Conferences,\ \ and Participants" nullable: true type: string url: description: The URL of this resource. format: uri nullable: true type: string type: object bulkexports.v1.export.day: properties: create_date: description: The date when resource is created nullable: true type: string day: description: The date of the data in the file nullable: true type: string friendly_name: description: The friendly name specified when creating the job nullable: true type: string resource_type: description: "The type of communication \u2013 Messages, Calls, Conferences,\ \ and Participants" nullable: true type: string size: description: Size of the file in bytes nullable: true type: integer type: object bulkexports.v1.export.day-instance: properties: redirect_to: format: uri nullable: true type: string type: object bulkexports.v1.export.export_custom_job: properties: details: description: 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 nullable: true type: object email: description: The optional email to send the completion notification to nullable: true type: string end_day: description: 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. nullable: true type: string estimated_completion_time: description: 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 nullable: true type: string friendly_name: description: The friendly name specified when creating the job nullable: true type: string job_queue_position: description: 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 nullable: true type: string job_sid: description: The unique job_sid returned when the custom export was created. This can be used to look up the status of the job. maxLength: 34 minLength: 34 nullable: true pattern: ^JS[0-9a-fA-F]{32}$ type: string resource_type: description: "The type of communication \u2013 Messages, Calls, Conferences,\ \ and Participants" nullable: true type: string start_day: description: The start day for the custom export specified as a string in the format of yyyy-MM-dd nullable: true type: string webhook_method: description: This is the method used to call the webhook nullable: true type: string webhook_url: description: The optional webhook url called on completion nullable: true type: string type: object bulkexports.v1.export.job: properties: details: description: 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 nullable: true type: object email: description: The optional email to send the completion notification to nullable: true type: string end_day: description: The end time for the export specified when creating the job nullable: true type: string estimated_completion_time: description: 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 nullable: true type: string friendly_name: description: The friendly name specified when creating the job nullable: true type: string job_queue_position: description: 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 nullable: true type: string job_sid: description: The job_sid returned when the export was created maxLength: 34 minLength: 34 nullable: true pattern: ^JS[0-9a-fA-F]{32}$ type: string resource_type: description: "The type of communication \u2013 Messages, Calls, Conferences,\ \ and Participants" nullable: true type: string start_day: description: The start time for the export specified when creating the job nullable: true type: string url: format: uri nullable: true type: string webhook_method: description: This is the method used to call the webhook nullable: true type: string webhook_url: description: The optional webhook url called on completion nullable: true type: string type: object bulkexports.v1.export_configuration: properties: enabled: description: Whether files are automatically generated nullable: true type: boolean resource_type: description: "The type of communication \u2013 Messages, Calls, Conferences,\ \ and Participants" nullable: true type: string url: description: The URL of this resource. format: uri nullable: true type: string webhook_method: description: Whether to GET or POST to the webhook url nullable: true type: string webhook_url: description: URL targeted at export format: uri nullable: true type: string type: object securitySchemes: accountSid_authToken: scheme: basic type: http info: contact: email: support@twilio.com name: Twilio Support url: https://support.twilio.com description: This is the public Twilio REST API. license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Bulkexports version: 1.27.0 openapi: 3.0.1 paths: /v1/Exports/Jobs/{JobSid}: delete: description: '' operationId: DeleteJob parameters: - description: The unique string that that we created to identify the Bulk Export job in: path name: JobSid required: true schema: maxLength: 34 minLength: 34 pattern: ^JS[0-9a-fA-F]{32}$ type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: 'TODO: Resource-level docs' get: description: '' operationId: FetchJob parameters: - description: The unique string that that we created to identify the Bulk Export job in: path name: JobSid required: true schema: maxLength: 34 minLength: 34 pattern: ^JS[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/bulkexports.v1.export.job' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://bulkexports.twilio.com x-twilio: defaultOutputProperties: - details - email - end_day - estimated_completion_time - friendly_name - job_queue_position - job_sid - resource_type - start_day - webhook_method - webhook_url pathType: instance /v1/Exports/{ResourceType}: description: 'TODO: Resource-level docs' get: description: Fetch a specific Export. operationId: FetchExport parameters: - description: "The type of communication \u2013 Messages, Calls, Conferences,\ \ and Participants" in: path name: ResourceType required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/bulkexports.v1.export' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://bulkexports.twilio.com x-twilio: defaultOutputProperties: [] pathType: instance /v1/Exports/{ResourceType}/Configuration: description: 'TODO: Resource-level docs' get: description: Fetch a specific Export Configuration. operationId: FetchExportConfiguration parameters: - description: "The type of communication \u2013 Messages, Calls, Conferences,\ \ and Participants" in: path name: ResourceType required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/bulkexports.v1.export_configuration' description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: Update a specific Export Configuration. operationId: UpdateExportConfiguration parameters: - description: "The type of communication \u2013 Messages, Calls, Conferences,\ \ and Participants" in: path name: ResourceType required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: Enabled: description: If true, Twilio will automatically generate every day's file when the day is over. type: boolean WebhookMethod: description: Sets whether Twilio should call a webhook URL when the automatic generation is complete, using GET or POST. The actual destination is set in the webhook_url type: string WebhookUrl: description: Stores the URL destination for the method specified in webhook_method. format: uri type: string title: UpdateExportConfigurationRequest type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/bulkexports.v1.export_configuration' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://bulkexports.twilio.com x-twilio: defaultOutputProperties: - enabled - resource_type - url - webhook_method - webhook_url pathType: instance /v1/Exports/{ResourceType}/Days: description: 'TODO: Resource-level docs' get: description: Retrieve a list of all Days for a resource. operationId: ListDay parameters: - description: "The type of communication \u2013 Messages, Calls, Conferences,\ \ and Participants" in: path name: ResourceType required: true schema: type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: days: items: $ref: '#/components/schemas/bulkexports.v1.export.day' type: array meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri type: string page: type: integer page_size: type: integer previous_page_url: format: uri type: string url: format: uri type: string type: object title: ListDayResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://bulkexports.twilio.com x-twilio: defaultOutputProperties: - friendly_name - create_date - day - resource_type - size - redirectTo pathType: list /v1/Exports/{ResourceType}/Days/{Day}: description: 'TODO: Resource-level docs' get: description: Fetch a specific Day. operationId: FetchDay parameters: - description: "The type of communication \u2013 Messages, Calls, Conferences,\ \ and Participants" in: path name: ResourceType required: true schema: type: string - description: The ISO 8601 format date of the resources in the file, for a UTC day in: path name: Day required: true schema: type: string responses: '307': content: application/json: schema: $ref: '#/components/schemas/bulkexports.v1.export.day-instance' description: Temporary Redirect security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://bulkexports.twilio.com x-twilio: defaultOutputProperties: - friendly_name - create_date - day - resource_type - size - redirectTo pathType: instance /v1/Exports/{ResourceType}/Jobs: description: 'TODO: Resource-level docs' get: description: '' operationId: ListExportCustomJob parameters: - description: "The type of communication \u2013 Messages, Calls, Conferences,\ \ and Participants" in: path name: ResourceType required: true schema: type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: jobs: items: $ref: '#/components/schemas/bulkexports.v1.export.export_custom_job' type: array meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri type: string page: type: integer page_size: type: integer previous_page_url: format: uri type: string url: format: uri type: string type: object title: ListExportCustomJobResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: '' operationId: CreateExportCustomJob parameters: - description: "The type of communication \u2013 Messages or Calls, Conferences,\ \ and Participants" in: path name: ResourceType required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: Email: description: The optional email to send the completion notification to. You can set both webhook, and email, or one or the other. If you set neither, the job will run but you will have to query to determine your job's status. type: string EndDay: description: The end day for the custom export specified as a string in the format of yyyy-mm-dd. End day is inclusive and must be 2 days earlier than the current UTC day. type: string FriendlyName: description: The friendly name specified when creating the job type: string StartDay: description: The start day for the custom export specified as a string in the format of yyyy-mm-dd type: string WebhookMethod: description: This is the method used to call the webhook on completion of the job. If this is supplied, `WebhookUrl` must also be supplied. type: string WebhookUrl: description: The optional webhook url called on completion of the job. If this is supplied, `WebhookMethod` must also be supplied. If you set neither webhook nor email, you will have to check your job's status manually. type: string required: - StartDay - EndDay - FriendlyName title: CreateExportCustomJobRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/bulkexports.v1.export.export_custom_job' description: Created security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://bulkexports.twilio.com x-twilio: defaultOutputProperties: - details - email - end_day - estimated_completion_time - friendly_name - job_queue_position - job_sid - resource_type - start_day - webhook_method - webhook_url pathType: list servers: - url: https://bulkexports.twilio.com x-maturity: - description: This product is Generally Available. name: GA