Icon

Integrate into your application using our REST API

video/bl/ API is really simple to use and given its REST nature is compatible with all programming languages.

At its core - 6 simple functions:

Create request

URL: http://videobl.com/requests
Request Method: POST
Header Parameters
  • Content-Type: application/json
  • Accept: application/json
Request Body:

{
  "auth_token": "you can find this in your Settings",
  "confirmation": {
      "text": "text of your request - this can be a text that user repeats or a question that he or she needs to answer",
      "description": "description of this request, for internal user",
      "action": "http://place-where-you-want-the-user-to-go-after.com"
  }
}
        

Example Response
 {
  "recording_url":"http://videobl.com/r/3y",
  "transaction_id":"tr1obMQBxu2fmAnn"
}
       

CURL example
curl -H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-X POST http://videobl.com/requests \
-d '{"auth_token": "AUTH_TOKEN", "request": {"text": "some confirmation text", "description":"created via curl","action":"http://somereturnurl.com/test"}}'	
		

Retrieve a list of your requests

URL: http://videobl.com/requests
Request Method: GET
Header Parameters
  • Content-Type: application/json
  • Accept: application/json
Request Body:
{
 "auth_token": "you can find this in your Settings"
}
        
Example Response
 [
     {
         "text": "some request text",
         "recording_url": "http://videobl.com/r/2h",
         "created_at": "2012/01/03 19/33",
         "short_code": "2h",
         "status": "COMPLETE",
         "description": "created via curl",
         "transaction_id": "ByQ8W5ujziDPbgnn",
         "replies_count":0
     },...
 ]
        
CURL Example
curl -H 'Content-Type: application/json' -H 'Accept: application/json' -X GET http://videobl.com/requests -d '{"auth_token": "AUTH_TOKEN"}'			
		

Obtain a status for a specific request

URL: http://videobl.com/requests/status
Note: :transaction_id is a value received during request creation.
Request Method: GET
Header Parameters
  • Content-Type: application/json
  • Accept: application/json
Request Body:
{
 "auth_token": "you can find this in your Settings",
 "transaction_id": "transaction id of the request you want to see"
}
        
Example Response
{
    "text": "some confirmation text",
    "recording_url": "http://videobl.com/r/2h",
    "created_at": "2012/01/03 19/33",
    "short_code": "2h",
    "status": "COMPLETE",
    "description": "created via curl",
    "completed_at": "2012/01/03 23/53",
    "transaction_id": "xxxxxxxxyyyyzzzz",
    "replies_count": 0
}
        
CURL Example
curl -H 'Content-Type: application/json' \
 -H 'Accept: application/json' \
 -X GET http://videobl.com/requests/status \
 -d '{"auth_token":"AUTH_TOKEN","transaction_id":"TRANSACTION_ID"}'
		

Get list of available replies.

URL:http://videobl.com/replies
Request Method: GET
Header Parameters
  • Content-Type: application/json
  • Accept: application/json
Request Body:
{
	"auth_token": "you can find this in your Settings"
}
            
Example Response
[{
	"completed_at":"2012/05/07 13/56","transaction_id":"xxxxxxxxxxxx","duration":"00:00:15"
}...]
            
CURL Example
curl -H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-X GET http://videobl.com/replies \
-d '{"auth_token":"AUTH_TOKEN"}'
			

Get reply details by transaction id

URL:http://videobl.com/replies/:transaction_id
Note: :transaction_id is a value of reply that can be recieved through list of replies.

Request Method: GET
Header Parameters
  • Content-Type: application/json
  • Accept: application/json
Request Body:
{
 "auth_token": "you can find this in your Settings"
}
            
Example Response
{
	"completed_at":"2012/05/07 13/56","transaction_id":"xxxxxxxxxxx","duration":"00:00:15"
}
            
CURL Example
curl -H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-X GET http://videobl.com/replies/TRANSACTION_ID \
-d '{"auth_token":"AUTH_TOKEN"}'
		
	

Download recorded response

URL: http://videobl.com/replies/download
Note: :transaction_id is a value received during request creation.
Request Method: GET
Header Parameters
  • Content-Type: application/json
  • Accept: application/octet-stream
Request Body:
{
 "auth_token": "you can find this in your Settings",
 "transaction_id": "transaction id of the reply you want to download"
}
        
Example Response

In this case you will get an octet stream of mp4 file.

CURL Example
curl -H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-X GET http://videobl.com/replies/download  \
-d '{"auth_token":"AUTH_TOKEN","transaction_id":"TRANSACTION_ID"}'