Skip to content

Commit

Permalink
Update clients-api.adoc
Browse files Browse the repository at this point in the history
  • Loading branch information
deruelle committed Oct 16, 2016
1 parent 5819f62 commit 1539ff3
Showing 1 changed file with 8 additions and 8 deletions.
Expand Up @@ -37,7 +37,7 @@ Only registered Clients are allowed to use the *B2BUA/P2P/Proxy* functionalities
|VoiceApplicationSid |If this entry contains an Sid to a voice application then RestComm will ignore these voice URLs and use the voice URLs specified by the voice application.
|StatusCallback |The URL that RestComm will request to pass status parameters (such as the call state) to your application.
|StatusCallbackMethod |The HTTP method RestComm will use to make requests to the StatusCallback URL. Either GET or POST.
|Uri |The URI for this Client, relative to http://localhost:port/restcomm.
|Uri |The URI for this Client, relative to https://localhost:port/restcomm.
|===============================================================================================================================================================================

=== Supported Operations
Expand Down Expand Up @@ -98,7 +98,7 @@ Only registered Clients are allowed to use the *B2BUA/P2P/Proxy* functionalities
The client name will be Alice as shown below

....
curl -X POST http://ACae6e420f425248d6a26948c17a9e2acf:77f8c12cc7b8f8423e5c38b035249166@127.0.0.1:8080/restcomm/2012-04-24/Accounts/ACae6e420f425248d6a26948c17a9e2acf/Clients.json -d "Login=alice" -d "Password=test"
curl -X POST https://ACae6e420f425248d6a26948c17a9e2acf:77f8c12cc7b8f8423e5c38b035249166@127.0.0.1/restcomm/2012-04-24/Accounts/ACae6e420f425248d6a26948c17a9e2acf/Clients.json -d "Login=alice" -d "Password=test"
....

The output of the command will be similar to the one below
Expand All @@ -124,28 +124,28 @@ The output of the command will be similar to the one below
You must use the Client SID

....
curl -X DELETE http://ACae6e420f425248d6a26948c17a9e2acf:77f8c12cc7b8f8423e5c38b035249166@127.0.0.1:8080/restcomm/2012-04-24/Accounts/ACae6e420f425248d6a26948c17a9e2acf/Clients/CL4e10e3b56a614414bcc1eeca5d96effe
curl -X DELETE https://ACae6e420f425248d6a26948c17a9e2acf:77f8c12cc7b8f8423e5c38b035249166@127.0.0.1/restcomm/2012-04-24/Accounts/ACae6e420f425248d6a26948c17a9e2acf/Clients/CL4e10e3b56a614414bcc1eeca5d96effe
....

== Change Client's Password

You must use the Client SID as shown below:

....
curl -X PUT http://ACae6e420f425248d6a26948c17a9e2acf:77f8c12cc7b8f8423e5c38b035249166@127.0.0.1:8080/restcomm/2012-04-24/Accounts/ACae6e420f425248d6a26948c17a9e2acf/Clients/CL4e10e3b56a614414bcc1eeca5d96effe -d "Password=NewPassword"
curl -X PUT https://ACae6e420f425248d6a26948c17a9e2acf:77f8c12cc7b8f8423e5c38b035249166@127.0.0.1/restcomm/2012-04-24/Accounts/ACae6e420f425248d6a26948c17a9e2acf/Clients/CL4e10e3b56a614414bcc1eeca5d96effe -d "Password=NewPassword"
....

== Get List of available Clients

The command below shows all Clients created using the default Admin Account

....
curl -X GET http://ACae6e420f425248d6a26948c17a9e2acf:77f8c12cc7b8f8423e5c38b035249166@127.0.0.1:8080/restcomm/2012-04-24/Accounts/ACae6e420f425248d6a26948c17a9e2acf/Clients/
curl -X GET https://ACae6e420f425248d6a26948c17a9e2acf:77f8c12cc7b8f8423e5c38b035249166@127.0.0.1/restcomm/2012-04-24/Accounts/ACae6e420f425248d6a26948c17a9e2acf/Clients/
....


----
curl -X GET http://ACae6e420f425248d6a26948c17a9e2acf:R3stC0mm@54.204.90.224:8080/restcomm/2012-04-24/Accounts/ACae6e420f425248d6a26948c17a9e2acf/Clients
curl -X GET https://ACae6e420f425248d6a26948c17a9e2acf:R3stC0mm@127.0.0.1/restcomm/2012-04-24/Accounts/ACae6e420f425248d6a26948c17a9e2acf/Clients
----

XML GET Response
Expand Down Expand Up @@ -189,7 +189,7 @@ XML GET Response


----
curl -X GET http://ACae6e420f425248d6a26948c17a9e2acf:R3stC0mm@54.204.90.224:8080/restcomm/2012-04-24f425248d6a26948c17a9e2acf/Clients.json
curl -X GET https://ACae6e420f425248d6a26948c17a9e2acf:R3stC0mm@127.0.0.1/restcomm/2012-04-24f425248d6a26948c17a9e2acf/Clients.json
----

JSON GET Response
Expand Down Expand Up @@ -225,4 +225,4 @@ JSON GET Response
"uri": "/restcomm/2012-04-24/Accounts/ACae6e420f425248d6a26948c17a9e2acf/Clients/CLa2b99142e111427fbb489c3de357f60a.json"
}
]
----
----

0 comments on commit 1539ff3

Please sign in to comment.