개요
작업 또는 출력 파일이 완료된 후 여러 방법으로 이에 대해 알아볼 수 있습니다.
- 우리는 보낼 수 있습니다 HTTP POST 요청세부 사항과 함께 응용 프로그램에.
- 이메일을 보낼 수 있습니다.
- 다음과 같은 타사 도구를 사용하여 알림을 요청할 수 있습니다. ngrok . 이것은 로컬에서 개발 중이고 Zencoder가 개발 서버에 연결할 수 없을 때 유용합니다.
- Zencoder 대시 보드에서 작업 상태를 확인할 수 있습니다.
- Job show API 요청을 통해 작업 상태를 확인할 수 있습니다.
처음 두-발신 HTTP또는 이메일 알림-작업 생성 API 요청에 알림 옵션을 추가하여 트리거됩니다.
참고 사항:
- 알림은 출력 및 작업 당 5 개로 제한됩니다. 출력 알림은 작업 총계에 포함되지 않습니다. 문의하기더 필요한 경우.
- 알림 페이로드는 작업에 대한 알림을 반복 할 수 있습니다. 작업 ID로 페이로드 본문을 파싱 한 다음 상태를 지정해야합니다.
- HTTP2 기반의 서버의 알림 처리기는 현재 지원되지 않습니다. HTTP2 서버로 전송된 알림은 오류를 반환하지 않고 배달되지 않을 수 있습니다.
알림
notifications:Array
API 버전: V2
유효한 값 : 알림 문자열 (유효한 이메일 주소 또는 URL)의 배열 또는 해시url과format .
호환 가능한 작업 유형: VOD
설명:
작업 또는 출력이 완료되면 웹훅으로 알릴 하나 이상의 HTTP URL 또는 이메일 주소를 지정하십시오.
HTTP 알림의 경우 알림 API 요청이 Zencoder에서 서버로 전송됩니다. POST두 개 또는 세 개의 값을 포함하는 JSON 또는 XML입니다. 첫 번째는 작업 ID입니다. 이 ID는 초기 작업 요청을 제출할 때받은 ID와 일치합니다. 두 번째는 '완료 됨', '실패'또는 '취소됨'상태입니다. 작업에 여러 출력이 포함 된 경우이 알림에는 작업을 처음 만들 때 제공 한 출력 레이블도 포함됩니다.
HTTP 알림은 요청 된 내용에 따라 JSON 또는 XML을 전송합니다. format ).
알림 내용에 따라 달라집니다사용 된 API 버전 .
알림을 보낼 때 Zencoder가 대상 서버에 성공적으로 연결할 수없는 경우 알림이 대기열에 추가되어 다시 시도합니다. 재시도 일정은알림 가이드 .
권한 부여 및 보안
인증 된 HTTP 알림의 경우 https : // username : password@www.example.com/path/to/notification/action 구문을 사용하여 알림 URL에 사용자 이름과 비밀번호를 포함합니다.
HTTPS의 경우 다음을 사용하여 URL을 지정하면됩니다. https:// SSL을 사용하여 알림이 안전하게 전송되도록합니다.
참고: API V1은 작업 알림이 아닌 출력 알림만 지원합니다.
{
"input": "s3://zencodertesting/test.mov",
"notifications": [
"dev@example.com",
"http://user:pass@example.com/path/to/notification/action",
{
"format": "xml",
"url": "https://example.com/notifications.html"
}
],
"outputs": [
{
"notifications": [
"dev@example.com",
"http://user:pass@example.com/path/to/notification/action",
{
"format": "xml",
"url": "https://example.com/notifications.html"
}
]
}
]
}
url
url:String
API 버전: V2
부모의: notifications
유효한 값 : 알릴 유효한 HTTP 또는 HTTPS URL (선택적으로 HTTP 인증 자격 증명 포함)
호환 가능한 작업 유형: VOD
예 :
- https://username:password@example.com/notification/path
- http://example.com/notification-handler.php
설명:
URL 알리다작업이 완료되면
사용url지정시 옵션notifications다음을 포함하여 해시로format . 형식을 지정할 필요가없는 경우 URL을 알림 배열의 항목으로 포함하기 만하면됩니다.
인증 된 HTTP 알림의 경우 https : // username : password@www.example.com/path/to/notification/action 구문을 사용하여 알림 URL에 사용자 이름과 비밀번호를 포함합니다.
HTTPS의 경우 다음을 사용하여 URL을 지정하면됩니다. https://따라서 알림은 SSL을 사용하여 안전하게 전송됩니다.
알림 내용에 따라 달라집니다사용 된 API 버전 .
알림을 보낼 때 Zencoder가 대상 서버에 성공적으로 연결할 수없는 경우 알림이 대기열에 추가되어 다시 시도합니다. 알림은 최대 20 번 시도되며 시도 간격은 매번 두 배로 늘어납니다.
권한 부여 및 보안
인증 된 HTTP 알림의 경우 https : // username : password@www.example.com/path/to/notification/action 구문을 사용하여 알림 URL에 사용자 이름과 비밀번호를 포함합니다.
HTTPS의 경우 다음을 사용하여 URL을 지정하면됩니다. https:// SSL을 사용하여 알림이 안전하게 전송되도록합니다.
참고 사항: API V1은 작업 알림이 아닌 출력 알림만 지원합니다.
{
"input": "s3://zencodertesting/test.mov",
"notifications": [
{
"url": "https://example.com/notifications.html"
}
],
"outputs": [
{
"notifications": [
{
"url": "https://example.com/notifications.html"
}
]
}
]
}
또한보십시오: notifications , format , 및headers
체재
format:String
API 버전: V2
부모의: notifications
유효한 값 : json또는xml
호환 가능한 작업 유형: VOD
예: json
설명:
형식 및 콘텐츠 유형notifications .
기본적으로 HTTP 알림은 JSON 형식이며 HTTP Content-Type은application/json .
XML 알림의 경우 형식을 'xml'로 설정하십시오. 그러면 HTTP Content-Type이 다음과 같은 XML 형식의 알림이 반환됩니다. application/xml .
참고: API V1 알림은 형식을 지정하지 않는 한 HTTP Content-Type을 포함하지 않습니다.
{
"input": "s3://zencodertesting/test.mov",
"notifications": [
{
"format": "xml",
"url": "https://example.com/notifications.html"
}
],
"outputs": [
{
"notifications": [
{
"format": "xml",
"url": "https://example.com/notifications.html"
}
]
}
]
}
또한보십시오: notifications , format , 및headers
헤더
headers:Hash
API 버전: V2
부모의: notifications
유효한 값 : 키는 문자로 시작해야하며 문자, 숫자 및-를 포함 할 수 있습니다. 값은 모든 문자열을 포함 할 수 있습니다.
각 알림 헤더의 길이 제한은 100 자입니다.
호환 가능한 작업 유형: VOD
예: {'Accept': 'application/json', 'Internal-Id': '12345'}
설명:
기본적으로 HTTP 알림은 User-Agent와 함께 HTTP Content-Type과 함께 전송됩니다. 애플리케이션에 추가 헤더가 필요한 경우 여기에서 지정할 수 있습니다.
헤더는 해시의 키로 설정되고 그 값은 해시의 값입니다.
{
"input": "s3://zencodertesting/test.mov",
"notifications": [
{
"format": "json",
"url": "https://example.com/notifications.html",
"headers": {
"Accept": "application/json",
"Internal-Id": "12345"
}
}
],
"outputs": [
{
"notifications": [
{
"format": "json",
"url": "https://example.com/notifications.html",
"headers": {
"Accept": "application/json",
"Internal-Id": "12345"
}
}
]
}
]
}
또한보십시오: notifications , url , 및format
이벤트
event:String
API 버전: V2
부모의: notifications
유효한 값 : first_segment_uploaded , seamless_playback
호환 가능한 작업 유형: VOD
예: {'event': 'seamless_playback'}
설명:
라이브 출력에는 파일 진행 상황에 따른 추가 알림 이벤트가 있습니다.
라이브 출력의 첫 번째 세그먼트가 업로드되고 끊김없는 재생이 가능하도록 충분한 세그먼트가 업로드 된 경우 알림을 보낼 수 있습니다.
이벤트는 일반 작업 및 출력 알림에는 적용되지 않으며 라이브 출력에만 적용됩니다.
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"live_stream": true,
"type": "segmented",
"notifications": [
{
"url": "http://zencoderfetcher/notifications.html",
"event": "seamless_playback"
}
]
}
]
}
또한보십시오: notifications , url , 및format