Validate Stream URL

Validates that our service can connect to a social media or content distribution platform using the stream URL associated with a specific publishing targetRefers to a configuration that identifies the URL to which your content may be published. A publishing schedule leverages a publishing target configuration to syndicate a live channel or a live event to a social media platform..

This endpoint cannot be used to verify HLS pull streams, since our service does not connect to a social media or content distribution platform when publishing a pull target. Rather, it is up to the social media or content distribution platform to pull the stream using the publishing schedule's HLS pull URL.

Request

Request syntax:

PATCH /syndication-target-test/Publishing Target ID

Define the following variable when submitting the above request:

Request body parameters:

Pass the following request body parameters:

Response

The response for a successful request contains the following properties:

platform_config Dictionary

The platform_config dictionary contains the following platform-specific settings:

test Dictionary

The test dictionary contains the results for the following tests:

• Stream URL syntax.
• Social media or content distribution platform connection.

Sample Request/Response

Call the validate_stream_url module (Python 3) to validate a stream URL. This module imports names from the api_auth module.

import requests
from api_auth import APICredentials, APIParams

import json
import requests
from api_auth import APICredentials, APIParams

class ValidateStreamURL:
    def __init__(self):
        self.host = "https://services.uplynk.com"

    def run(self):
        self._validate_stream_url()

    def _validate_stream_url(self):
        publishing_target_id = 'b7abed5070384462ae0fec6bd791262e'
        url = "{}{}{}".format(self.host, "/api/v4/syndication-target-test/", publishing_target_id)

        payload = {'test': 'rtmp-connection'}
        headers = {'Content-Type': 'application/json'}
        response = requests.patch(
            url, params=APIParams(APICredentials()).get_params({}), data=json.dumps(payload), headers=headers
        )

        print(response.json())

ValidateStreamURL().run()

Response:

{
	"@id": "/api/v4/syndication-target-test/b7abed5070384462ae0fec6bd791262e",
	"@type": "SyndicationTargetAction",
	"id": "b7abed5070384462ae0fec6bd791262e",
	"platform": "Facebook",
	"description": "Facebook publishing",
	"target_protocol": "rtmp",
	"target_stream": "******",
	"status": "stopped",
	"test": {
		"passed": [
			"uri is valid"
		],
		"failed": [
			"failure to connect via rtmp"
		]
	}
}