> Fetch clean Markdown by appending `.md` to any page URL under https://signalwire.com/docs or requesting it with the HTTP header `Accept: text/markdown`. The root index at https://signalwire.com/docs/llms.txt lists the available documentation indexes. # Assign Resource to SIP credential POST https://%7BYour_Space_Name%7D.signalwire.com/api/fabric/resources/{id}/sip_endpoints Content-Type: application/json Assigns an existing resource as the calling handler for a SIP Credential. Use it when calls placed by the registered SIP device should run that resource's instructions. This operation does not create a credential; use [Create SIP credential](/docs/apis/rest/sip-credentials/create-sip-credential) first when the device does not yet have one. Currently only supports `calling` as a handler and automatically defaults to it. #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: *Voice*, *Messaging*, *Fax*, or *Video*. [Learn more about API scopes](/docs/platform/your-signalwire-api-space). Reference: https://signalwire.com/docs/apis/rest/sip-credentials/assign-resource-to-sip-credential ## Authentication - `Authorization` header (basic auth, required) — SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ``` ## Request ### Path parameters - `id` (string, required) — The unique identifier of the Resource. ### Body (application/json) This endpoint expects a ResourceSipEndpointAssignRequest. - `sip_endpoint_id` (string, required) — The unique identifier of the SIP endpoint. ## Response ### 200 The request has succeeded. - `id` (string, required) — The unique identifier of the SIP endpoint. - `name` (string, required) — The name for the SIP endpoint. - `type` (enum, required) — The Resource type - Allowed values: `call` - `cover_url` (string, required, nullable) — The cover URL for the SIP endpoint. - `preview_url` (string, required, nullable) — The preview URL for the SIP endpoint. - `channels` (AddressChannel, required) — An object containing the resource addresses with the specified comunication channels ## Errors ### 401 Unauthorized Error Access is unauthorized. - `error` (enum, required) - Allowed values: `Unauthorized` ### 404 Not Found Error The server cannot find the requested resource. - `error` (enum, required) - Allowed values: `Not Found` ### 422 Unprocessable Entity Error The request contains invalid parameters. See errors for details. - `errors` (list of Types.StatusCodes.RestApiErrorItem, required) — List of validation errors. ### 500 Internal Server Error An internal server error occurred. - `error` (enum, required) - Allowed values: `Internal Server Error` ## Types ### AddressChannel ### Types.StatusCodes.RestApiErrorItem Details about a specific error. - `type` (string, required) — The category of error. - `code` (string, required) — A specific error code. - `message` (string, required) — A description of what caused the error. - `url` (string, required) — A link to documentation about this error. - `attribute` (string, optional, nullable) — The request parameter that caused the error, if applicable. ### AudioChannel - `audio` (string, required) — Audio Channel of Fabric Address ### MessagingChannel - `messaging` (string, required) — Messaging Channel of Fabric Address ### VideoChannel - `video` (string, required) — Video Channel of Fabric Address ## Examples **Request** ```json { "sip_endpoint_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ``` **Response** ```json { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "sip_user", "type": "call", "cover_url": "https://example.com/cover.jpg", "preview_url": "https://example.com/preview.jpg", "channels": { "audio": "/external/resource_name?channel=audio" } } ``` **SDK Code** ```python import requests url = "https://{your_space_name}.signalwire.com/api/fabric/resources/id/sip_endpoints" payload = { "sip_endpoint_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } headers = { "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers, auth=("", "")) print(response.json()) ``` ```javascript const url = 'https://{your_space_name}.signalwire.com/api/fabric/resources/id/sip_endpoints'; const credentials = btoa(":"); const options = { method: 'POST', headers: { Authorization: `Basic ${credentials}`, 'Content-Type': 'application/json' }, body: '{"sip_endpoint_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://{your_space_name}.signalwire.com/api/fabric/resources/id/sip_endpoints" payload := strings.NewReader("{\n \"sip_endpoint_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n}") req, _ := http.NewRequest("POST", url, payload) req.SetBasicAuth("", "") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://{your_space_name}.signalwire.com/api/fabric/resources/id/sip_endpoints") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request.basic_auth("", "") request["Content-Type"] = 'application/json' request.body = "{\n \"sip_endpoint_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://{your_space_name}.signalwire.com/api/fabric/resources/id/sip_endpoints") .basicAuth("", "") .header("Content-Type", "application/json") .body("{\n \"sip_endpoint_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n}") .asString(); ``` ```php request('POST', 'https://{your_space_name}.signalwire.com/api/fabric/resources/id/sip_endpoints', [ 'body' => '{ "sip_endpoint_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }', 'headers' => [ 'Content-Type' => 'application/json', ], 'auth' => ['', ''], ]); echo $response->getBody(); ``` ```csharp using RestSharp; using RestSharp.Authenticators; var client = new RestClient("https://{your_space_name}.signalwire.com/api/fabric/resources/id/sip_endpoints"); client.Authenticator = new HttpBasicAuthenticator("", ""); var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"sip_endpoint_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let credentials = Data(":".utf8).base64EncodedString() let headers = [ "Authorization": "Basic \(credentials)", "Content-Type": "application/json" ] let parameters = ["sip_endpoint_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://{your_space_name}.signalwire.com/api/fabric/resources/id/sip_endpoints")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```