{ "opencollection": "1.0.0", "info": { "name": "API Endpoints subpackage_activities subpackage_phoneNumbers API", "version": "1.0.0" }, "items": [ { "info": { "name": "subpackage_phoneNumbers", "type": "folder" }, "items": [ { "info": { "name": "List or search for phone numbers", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/phone_number/", "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": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." }, { "name": "number", "value": "", "type": "query" }, { "name": "user_id", "value": "", "type": "query" }, { "name": "is_group_number", "value": "", "type": "query" } ] }, "docs": "List or search for phone numbers" }, { "info": { "name": "Request an internal phone number", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/phone_number/request/internal/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Renting a phone number incurs a cost. You need the \"Manage Group Phone Numbers\" permission to rent group numbers.\n\nIf a number was rented, a 201 response is returned with the new number. If no number was rented (4xx response code), the response contains a `status` field which may contain one of the values below. New statuses may be added in the future.\n\n* `has-voice-only`: This country/prefix combination only has non-SMS-capable\n numbers. You can attempt renting the number by passing `with_sms`" }, { "info": { "name": "Retrieve a single phone number", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/phone_number/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ] }, "docs": "Retrieve a single phone number" }, { "info": { "name": "Update a phone number", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/phone_number/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "You need the \"Manage Group Phone Numbers\" permission to update a group number. You can only update your own personal numbers.\n\nYou can:\n\n- Change a `label` of your number.\n- Set up call forwarding via `forward_to` and `forward_to_enabled`.\n- Set up a voicemail greeting by including a URL of an mp3 recording in `voicemail_greeting_url`. We require the URL to be secure (i.e. starting with https://).\n- Modify which team members are part of a group number via `participants`. This should be a list of" }, { "info": { "name": "Delete a phone number", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/phone_number/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "You need the \"Manage Group Phone Numbers\" permission to delete a group number. You can only delete your own personal numbers." } ] } ], "bundled": true }