{ "opencollection": "1.0.0", "info": { "name": "API Endpoints subpackage_activities subpackage_activitiesCalls API", "version": "1.0.0" }, "items": [ { "info": { "name": "subpackage_activitiesCalls", "type": "folder" }, "items": [ { "info": { "name": "List or filter all Call activities", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/activity/call/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." }, { "name": "id__in", "value": "", "type": "query", "description": "Filter by activity IDs (comma-separated)" }, { "name": "lead_id", "value": "", "type": "query", "description": "Filter by lead IDs (comma-separated)" }, { "name": "contact_id", "value": "", "type": "query", "description": "Filter by contact IDs (comma-separated)" }, { "name": "user_id", "value": "", "type": "query", "description": "Filter by user IDs (comma-separated)" }, { "name": "organization_id", "value": "", "type": "query" }, { "name": "_type", "value": "", "type": "query", "description": "Filter by activity type, e.g. Call (comma-separated)" }, { "name": "date_created__gte", "value": "", "type": "query" }, { "name": "date_created__lte", "value": "", "type": "query" }, { "name": "date_created__gt", "value": "", "type": "query" }, { "name": "date_created__lt", "value": "", "type": "query" }, { "name": "activity_at__gte", "value": "", "type": "query" }, { "name": "activity_at__lte", "value": "", "type": "query" }, { "name": "activity_at__gt", "value": "", "type": "query" }, { "name": "activity_at__lt", "value": "", "type": "query" } ] }, "docs": "List or filter all Call activities" }, { "info": { "name": "Log an external Call activity", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/activity/call/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to log calls made outside of the Close built-in VoIP system.\n\n*status*: defaults to `completed`\n\n*direction* (optional): `outbound` or `inbound`\n\n*recording_url*: you can post a URL pointing to the MP3 recording of your call. For security reasons, we require the URL to be secure (i.e. starting with https://)" }, { "info": { "name": "Get a single Call activity", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/activity/call/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a single Call activity" }, { "info": { "name": "Update a Call activity", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/activity/call/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Most commonly used to update `note_html` or `outcome_id`. Some fields (`status`, `duration`, `direction`) cannot be updated for internal calls made through Close's VoIP system.\n\n**`note_html` and `note`**: setting one overwrites the other. If both are provided, `note_html` takes precedence. `note_html` supports rich-text HTML; `note` is plaintext only." }, { "info": { "name": "Delete a Call activity", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/activity/call/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a Call activity" } ] } ], "bundled": true }